aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoreug-vs <eug-vs@keemail.me>2020-11-07 12:54:09 +0300
committereug-vs <eug-vs@keemail.me>2020-11-07 12:54:09 +0300
commitaaf784ab9fe5894c18493f116c6599faf3c92895 (patch)
tree726251ea347c13d3d329cce8fc6fcb07744c977e
parenta5feeaaca74d82a99bbb8063afee51cb9984f978 (diff)
downloadwhich-api-aaf784ab9fe5894c18493f116c6599faf3c92895.tar.gz
docs: update development and deployment sections
-rw-r--r--README.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/README.md b/README.md
index 47ef59c..70145eb 100644
--- a/README.md
+++ b/README.md
@@ -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
+