Blogify is a blog web application, a platform where users can create posts, read posts, comment on posts and also like those posts.
URL: https://github.com/abdul-razaq/Blogify.git
- node v12.16.1 or above
- yarn v1.22.4 or above
HTTP VERB | ENDPOINT | FUNCTIONALITY |
---|---|---|
POST | /api/v1/auth/signup | Register a new user account |
POST | /api/v1/auth/login | Login user into an existing account |
POST | /api/v1/auth/logout | Logout user from the application |
PATCH | /api/v1/auth/password/update | Update user's password |
GET | /api/v1/auth/user/profile | Retrieve a user's profile details |
PATCH | /api/v1/auth/user/profile/edit | Edit a user's profile |
DELETE | /api/v1/auth/user/delete | Delete a user's account |
POST | /api/v1/posts/ | Create a new post |
GET | /api/v1/posts?limit=10 | Retrieve all posts belonging to the user |
DELETE | /api/v1/posts/{postId} | Delete a post belonging to the user |
GET | /api/v1/posts/{postId} | Retrieve a single post belonging to the user |
GET | /api/v1/posts/feeds?limit=10 | Retrieve all posts feeds with a limit |
On your machine
-
Pull the [master] (https://github.com/abdul-razaq/Blogify.git) branch of this repository
-
Configure a
.env
file in the root directory with the following variables -
JWT_SECRET (JWT secret key)
-
DB_PASSWORD (Database Password)
-
DB_NAME (Database name (blogify))
-
DB_USER (Database user)
-
Run
yarn install
ORyarn add
to install all dependencies -
Run
yarn run dev
to start the app server -
Access endpoints on localhost:5000
Run yarn run test
in the terminal from the root directory of the cloned repo.
- node.js - runtime environment
URL: https://blogify-api.herokuapp.com/
URL: https://blogify-api.herokuapp.com/api-docs
- AbdulRazaq Ayomide Suleiman