Project Management REST API

About

REST API for a project management app.

This repo implements the backend REST API (built in Express + MongoDB).
A repository for with the frontend (React App) can be found here: https://github.com/Ironborn-Ironhack-March-2022/ironborn-project-management-client

To run in your computer, follow these steps:

clone
install dependencies: npm install
create a .env file with the following environment variables
- ORIGIN, with the location of your frontend app (example, ORIGIN=https://mycoolapp.netlify.com)
- TOKEN_SECRET: used to sign auth tokens (example, TOKEN_SECRET=ilovepizza)
run the application: npm run dev or npm start

Auth endpoints

HTTP verb	Path	Request Headers	Request body	Description
POST	/api/auth/signup	–	{ email: String, password: String }	Create an account
POST	/api/auth/login	–	{ email: String, password: String }	Login
GET	/api/auth/verify	Authorization: Bearer `<jwt>`	–	Verify jwt

Projects

HTTP verb	Path	Request Headers	Request body	Description
POST	/api/projects	Authorization: Bearer `<jwt>`	{ title: String, description: String }	Create new project
GET	/api/projects	–	–	Get all projects
GET	/api/projects/:projectId	–	–	Get project details
PUT	/api/projects/:projectId	Authorization: Bearer `<jwt>`	{ title: String, description: String, tasks: Array }	Update a project
DELETE	/api/projects/:projectId	Authorization: Bearer `<jwt>`	–	Delete a project

Tasks

HTTP verb	Path	Request Headers	Request body	Description
POST	/api/tasks	Authorization: Bearer `<jwt>`	{ title: String, description: String, projectId: ObjectId }	Create new task
GET	/api/tasks	–	–	Get all tasks. Not implemented (yet)
GET	/api/tasks/:taskId	–	–	Get task details. Not implemented (yet)