This application intends to build a real time todo list using websockets. This repository contains the backend code.
- NodeJS
- Express
- Socket.io
- PostgreSQL
- Sequelize
- Clone the repository
- Run
npm install
to install all the dependencies - Setup the postgres db by starting the postgres server and creating a database and setting migrations using the commands:
npx sequelize-cli db:migrate
- Run
npm start
to start the server
GET /todos
- Get all the todosPOST /todos
- Create a new todoPUT /todos/:id
- Update a todoDELETE /todos/:id
- Delete a todo
The documentation is built using JSdoc and can be found in the docs
folder.