update readme with deployment instructions

main
Ayush Mukherjee 4 years ago
parent bcb8d50fa5
commit c34d55fd53

@ -3,18 +3,8 @@
This is a **real-time** websocket service for handling live updates of stream data. This includes basic token authentication This is a **real-time** websocket service for handling live updates of stream data. This includes basic token authentication
through the CMS for creating/updating data. through the CMS for creating/updating data.
## Todos ## Instructions to deploy
- [x] data 1. Copy `env.example` as `.env` and fill in the details (make sure `NODE_ENV` is set to production)
- [x] create migrations with stream consideration 2. Run `npm i`
- [x] read from db 3. Expose port 5000 or use a reverse proxy which supports WebSockets
- [x] create data
- [x] update data
- [x] delete data
- [x] websocket
- [x] create ws server
- [x] handle events
- [x] authentication
- [x] create collection
- [x] figure out auth
- [x] casters and hosts stuff
Loading…
Cancel
Save