diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 24 insertions, 2 deletions
@@ -11,7 +11,29 @@ Track our progress - [KANBAN board](https://github.com/orgs/which-ecosystem/proj ### Building and running + +#### Running in Docker :whale: +You only need to have `Docker` and `docker-compose` installed for this step. +Turn off Mongo service to avoid port conflicts (container also exposes port 2707). +``` +docker-compose up +``` +This will build and run `which-api` container along with linked `mongo` container. + + +#### For local development :construction: +You need to have Mongo running at port 27017. ``` -ts-node populateDb.ts -ts-node-dev index.ts +npm install +npm start ``` + + +## Deployment :rocket: +Despite having Docker setup, `which-api` is currently deployed to [Heroku](https://dashboard.heroku.com/), +and MongoDB is located in [Mongo Atlas](https://www.mongodb.com/cloud/atlas). + +**API BASE URL**: https://which-api.herokuapp.com/ + +**MONGODB_URI**: mongodb+srv://cluster0.iayve.mongodb.net/which + |