DEVELOPER.md

Developer

This document describes how to set up your development environment to build and develop stellar.

• Prerequisite Software
• Code Editor
• Getting the Sources
• Installing NPM Modules
• Start Development Server
• Building For Production
• Cleaning

Prerequisite Software

Before you can run stellar you must install and configure the following products on your development machine:

• Git and/or the GitHub app; GitHub's Guide to Installing Git is a good source of information.

• Node.js LTS which is used to run a development web server, and generate distributable files. We recommend using the Node Version Manager (NVM) to install Node.js and NPM on your machine. Once you have NVM installed you can use the required Node.js/NPM versions via:

  cd stellar
  nvm use

Code Editor

The recommended editor for developing stellar is VS Code with the following settings and extensions. You can easily use another editor of your choice as long as you can replicate the code formatting settings.

Settings.json

Your editor should follow the same settings found in .vscode/settings.json.

Extensions

1. Svelte for VS Code
2. Prettier - Code formatter
3. ESLint
4. Stylelint
5. EditorConfig for VS Code
6. Path Intellisense
7. Code Spell Checker
8. Task Explorer

Getting the Sources

Clone the stellar repository:

git clone https://github.com/nasa-jpl/stellar.git
cd stellar

Installing NPM Modules

Install the JavaScript modules needed to build stellar:

npm install

Development

CSS

Any changes made to the CSS package locally must first be built via npm run build:css or the VSCode Task: Build CSS

To preview the changes, open packages/css/example/index.html in a browser.

React

To run the React package for development:

npm run dev:react (VSCode Task: React)

For more details, view the README for the package

Svelte

To run the Svelte package for development:

npm run dev:svelte (VSCode Task: Svelte)

For more details, view the README for the package

Building For Production

Run npm run build (VSCode Task: Build) to build a production version of the project. The built artifacts for each package will be stored in the dist/ directory under their respective workspaces.