Samiam

Identity project for the homeless.

Installation Instructions

There are two ways to run the application:

1. "Run Local", where the database and app are both served from your local machine
2. "Containers", where the app is deployed in a Docker container, connected to a separate database container. Both containers run on your machine.

Run Local

1. Install Git
2. Download this repo.
3. Install Node, at least version 10.1.
4. Install MongoDB
5. Run a local database instance from a terminal: mongod
6. Clone this repository, and cd into the directory.
7. npm install
8. npm run build
9. npm start
10. Open a browser to http://localhost:3000/.

Containers

For a container deployment, you do not even need to install node on your machine. The web server will be deployed onto a docker container image that already has node installed.

1. Install Git
2. Download this repo.
3. Install Docker
4. docker image build -t samiam .
5. docker-compose up -d staging-deps
6. Open a browser to http://localhost:3000/.
7. To shut down, docker-compose down

Deployment

You can easily deploy onto Heroku for free, just follow these instructions. Other cloud providers are similar.

1. Create a mongodb instance. mLab is a good resource.
2. Create a heroku app instance.
3. Put the mongo connection string into the environment variable MONGODB_CONNECT using the following command: heroku config:set MONGODB_CONNECT=[mongo_connect_url].
4. Set NODE_ENV: heroku config:set NODE_ENV=development.
5. Deploy by following the instructions in your heroku app dashboard. (You will add heroku to the git remotes, then push to it).