# PenPals
## API Endpoints

### auth

| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/auth/sign-up | POST | Add a new user | done |
| api/v1/auth/sign-in | POST | Allows a signed user to login |done
| api/v1/auth/sign-out | POST | Allows a signed user to sign out|done |
| api/v1/auth/verify | POST | verifiy email | done
| api/v1/auth/resend-email | POST | resend email | done
| api/v1/auth/forget-password | POST | forget password |

### Users

| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/users/me | GET | Get authorized user | |

### Posts

| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/posts/ | GET | Get all posts |
| api/v1/posts/:id | GET | Get one post |
| api/v1/posts | POST | Add a new post |
| api/v1/posts/:id | PUT | Update post content |
| api/v1/posts/:id | DELETE | Delete a post |

### Comments
| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/posts/post-id/comments| GET| Get all comments on the post |
| api/v1/posts/post-id/comments| POST| Add a new comment |
| api/v1/posts/post-id/comments/id| PUT | Update a comment |
| api/v1/posts/post-id/comments/id| DELETE | Delete a comment |

### feedBack
| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/feedBack/ | GET | Get all feedBack |
| api/v1/feedBack/:id | POST | Add a new feedBack | done
| api/v1/feedBack/:id | put | Edit a feedBack | done
| api/v1/feedBack/:id | DELETE | DELETE a feedBack | done

### projects
| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/projects/ | GET | Get all projects |
| api/v1/projects/ | POST | Add a new project|
| api/v1/projects/:id | GET | Get one project |
| api/v1/projects/:id | put | Edit a project |
| api/v1/projects/:id | DELETE | DELETE a project |

### Views

| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/views/:post-id| GET | Get all users who watched the post|
| api/v1/views/:post-id| POST | Add a new viewer to post|

### Notification

| Route| Method | Description | finished|
| -------- | -------- | -------- |-------|
| api/v1/views/notifications | GET | Get all Notification| done
| api/v1/views/notifications | POST | Add a new Notification| done