Skip to content

Commit 6bf6335

Browse files
Merge pull request #46 from wednesday-solutions/feat/update-readme
chore: update readme
2 parents cd33abc + 97a3887 commit 6bf6335

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,26 @@ A basic starter for a web app with parceljs, node, express and mongoose -->
5858

5959
---
6060

61-
## Pre-start
61+
## Pre-requisites
6262

6363
- yarn
6464
- docker
6565

6666
## Features
6767

68-
- Babel 7
69-
- Express
70-
- Bunyan
68+
- Mongo support
69+
- Docker support
70+
- Rate limited APIs
71+
- RBAC middleware using Auth0
72+
- Sharding mongoDB collection support
73+
- Paginated APIs
74+
- Autogenerated APIs from mongoose models
75+
- Built in slack alerting mecchanism
76+
- Suport for redis cache
77+
- Support for aggregate caching
78+
- Support for batch jobs in multi-container environment
79+
- Support for circuit breakers
80+
- Autogenerated swagger documentation
7181

7282
## Build and run docker container locally
7383

@@ -103,6 +113,10 @@ Run the following command to begin seeding
103113
- yarn start
104114
- open browser to `localhost:9000` (port default to 9000)
105115

116+
## API Documentation
117+
118+
Once you've to the server started check out the api documentation at [/api-docs](http://localhost:9000/api-docs)
119+
106120
## Philosophy
107121

108122
When using NoSQLs you are optimising for read performance. We're doing this by denormalising data. There are multiple copies of the same data. For example

0 commit comments

Comments
 (0)