From 3817264e6a3564e177eb05eb1af2c5faca8d7bb9 Mon Sep 17 00:00:00 2001 From: kajvans Date: Thu, 25 Jan 2024 16:55:50 +0100 Subject: [PATCH] readme --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 2f1718c..5ee482f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Short description or introduction of your project. - [About](#about) - [Features](#features) - [Installation](#installation) +- [Routes](#routes) - [License](#license) - [Creators](#creators) - [Contact](#contact) @@ -83,6 +84,39 @@ Run the project using npm start ``` +## Routes + +| Method | Path | +|--------|------| +| GET | /logout | +| GET | /register/password | +| POST | /register/ | +| POST | /login/ | +| GET | /user/:username | +| PUT | /user/description | +| PUT | /user/password | +| PUT | /user/username | +| PUT | /user/visibility | +| GET | /user/description/:username | +| GET | /user/visibility | +| GET | /user/activity/:type | +| DELETE | /user/delete | +| POST | /create/ | +| DELETE | /create/:id | +| GET | /post/:id | +| POST | /post/like/:postId | +| POST | /post/comment/:postId | +| POST | /post/comment/:postId/:commentId | +| POST | /post/like/:postId/:commentId | +| POST | /post/save/:postId | +| POST | /post/save/:postId/:commentId | +| POST | /search/:search | +| GET | /home/ | +| GET | /home/trending | +| GET | /home/mostLiked | +| GET | /home/mostCommented | +| GET | /home/mostSaved | + ## License This project is licensed under the [MIT License](LICENSE) - see the [LICENSE](LICENSE) file for details.