Skip to content

Latest commit

 

History

History
98 lines (56 loc) · 3.64 KB

README.md

File metadata and controls

98 lines (56 loc) · 3.64 KB
Raw
SLIM Logo

Software Lifecycle Improvement & Modernization (SLIM)

A shared community resource for discussing, iterating and referencing a common set of best practices in software development standards for NASA multi-mission space and ground software.

SLIM

screen-slim

This repository hosts the SLIM website, a project aimed at developing a common set of best practices in software development standards for NASA multi-mission space and ground software. The website leverages Docusaurus 2, a static website generator.

Website | Discussion Board | Issue Tracker

Features

  • Community-developed best practices and recommendations for software development encoded as Markdown guides
  • Static content for the SLIM website, including live preview during local development, and deployment support for GitHub pages hosting

Contents

Quick Start

To get started with the SLIM project website (including developing and building / deploying it), please follow the steps below.

Requirements

  • Node.js 12 or higher
  • Yarn package manager

Setup Instructions

  1. Clone the repository
  2. Navigate into the directory
  3. Run yarn to install dependencies

Run Instructions

  1. Run yarn start to start a local development server
  2. The command should open a browser window with the website running

Usage Examples

  • After making changes to the website, you can see them reflected live in your browser without having to restart the server.

Build Instructions

  1. Run yarn build to generate static content into the build directory

Test Instructions

  1. After building, the website can be served using any static contents hosting service.

Changelog

See our CHANGELOG.md for a history of our changes.

See our releases page for our key versioned releases.

Frequently Asked Questions (FAQ)

Ask us a question in our discussion board. We'll migrate common questions here.

Contributing

Please refer to the following resources for more information on contributing:

  • To learn how to contribute to our project, please consult our Contributing Guide.
  • To understand the community ideals and policies we adhere to, please review our Code of Conduct.
  • For insights into the governance model that governs our project, please refer to our Governance Model.

License

Please refer to our LICENSE for details regarding the licensing terms and conditions of our project.

Support

For inquiries regarding support, please reach out to the members of our Technical Steering Committee. They will be able to provide you with the necessary information and assistance.