In order to develop locally, you will need to install the following on your system:
NodeJS - Requires Node 9 or above, used for building the UI code and running the server
Yarn - Used for package management
Postgres - Requires Postgres 9.3 or above
After forking and cloning the repo:
- Start the Postgres server
./setup.sh
- This will create your .env.dev.local configuration file, install project dependencies, and create thestellarguard
database
yarn dev
- This builds the UI and starts a nodejs server on port 3000. Open your browser to http://localhost:3000 after running this
src/server - Code for the NodeJS server
src/ui - Code for the React-based UI
src/shared - Code that is shared in both the UI and Server (such as validations)
migrations - This is where database migrations are stored. Run migrations using db-migrate up
and create migrations with db-migrate create <migration name>
). See https://db-migrate.readthedocs.io/ for usage instructions
scripts - Standalone scripts such as deployment scripts and configuration