API for a todo list on steroids
https://wunderlist-api.herokuapp.com
- Bcrypt
- Cors
- Dotenv
- Express
- Helmet
- Jsonwebtoken
- Knex
- Postgres
- SQLite3
- Cross-Env (Development)
- Jest (Development)
- Nodemon (Development)
- Supertest (Development)
Install dependencies
npm i
Run the server
npm run server
Run tests
npm run test
Run database migrations
npx knex migrate:latest
Run database seeds
npx knex seed:run
To be able to access users route, you'll need to include valid JSON Web Token in your request Authorization header. To be able to acess todos route, you'll need to include valid JWT as well as userID in your request UserID header. Both the token and the id are aquired by registering an account or logging in.
POST /api/auth/register
will create a new user responding with token and userID. Required fields are username (string) and password (string).
POST /api/auth/login
will log in existing user responding with token and userID. Required fields are username (string) and password (string).
(protected route, requires JWT in request headers)
GET /api/users
will return an array of all users.
GET /api/users/:id
will return user with specified userID passed as request parameter.
DELETE /api/users/:id
will delete user with specified userID passed as request parameter.
PUT /api/users/:id
will update user with specified userID passed as request parameter. Required fields are username (string) and password (string). Returns newly updated user.
(protected route, requires both JWT and userID in request headers)
GET /api/todos
will return an array of all todos for given user.
POST /api/todos
will add a new todo for given user. Required fields are caption (string), description (string) and due_date (array of numbers structured like this [year, month, day, hour]). The value of completed and deleted fields will be automatically set to 0 (=false). Returns newly added todo.
GET /api/todos/:id
will return todo with specified id passed as request parameter. If the todo doesn't belong to the user with provided userID, it'll respond with message: 'You are not allowed to see this todo, as it belongs to someone else...'.
DELETE /api/todos/:id
will delete todo with specified id passed as request parameter. If the todo doesn't belong to the user with provided userID, it'll respond with message: 'You are not allowed to delete this todo, as it belongs to someone else...'.
PUT /api/todos/:id
will update todo with specified id passed as request parameter. If the todo doesn't belong to the user with provided userID, it'll respond with message: 'You are not allowed to update this todo, as it belongs to someone else...'. Required fields are caption (string), description (string) and due_date ([year, month, day, hour]). Other fields are completed (0 or 1) and deleted (0 or 1). Returns newly updated todo.
GET /api/todos/deleted
will return an array of all deleted todos for given user.
GET /api/todos/completed
will return an array of all completed todos for given user.