Skip to content

Commit

Permalink
Merge pull request #46 from wednesday-solutions/feat/update-readme
Browse files Browse the repository at this point in the history
chore: update readme
  • Loading branch information
alichherawalla authored May 30, 2022
2 parents cd33abc + 97a3887 commit 6bf6335
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,26 @@ A basic starter for a web app with parceljs, node, express and mongoose -->

---

## Pre-start
## Pre-requisites

- yarn
- docker

## Features

- Babel 7
- Express
- Bunyan
- Mongo support
- Docker support
- Rate limited APIs
- RBAC middleware using Auth0
- Sharding mongoDB collection support
- Paginated APIs
- Autogenerated APIs from mongoose models
- Built in slack alerting mecchanism
- Suport for redis cache
- Support for aggregate caching
- Support for batch jobs in multi-container environment
- Support for circuit breakers
- Autogenerated swagger documentation

## Build and run docker container locally

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

## API Documentation

Once you've to the server started check out the api documentation at [/api-docs](http://localhost:9000/api-docs)

## Philosophy

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
Expand Down

0 comments on commit 6bf6335

Please sign in to comment.