niksmac / stellarguard

StellarGuard

StellarGuard - protect your Stellar Lumens with multisig and two factor auth.

Getting Started

Prerequisites

In order to develop locally, you will need to install the following on your system:

NodeJS - Requires Node 10.13.0 or above, used for building the UI code and running the server

Yarn - Used for package management

Postgres - Requires Postgres 9.6 or above

Redis - Requires Redis 4.0 or above

After forking and cloning the repo:

1. Start the Postgres server -- a make command make docker-start will automatically start up the Postgres and Redis server in local container
2. Start the Redis server.
3. ./setup.sh - This will create your .env.dev.local configuration file, install project dependencies, and create the stellarguard database

Running the develoment server

yarn dev - This builds the UI and starts a nodejs server on port 3000. Open your browser to http://localhost:3000 after running this

Technologies Used

Server

• NodeJS
• Express

Front End

• Parcel - used for transpiling and bundling UI code
• React
• Material UI
• MobX

Data stores

• Postgres
• Redis

Project Structure

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

License

MIT