Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 1.92 KB

readme.md

File metadata and controls

76 lines (56 loc) · 1.92 KB

Tech Tips Hub Backend

Live link: https://tech-tips-hub-backend.vercel.app

Key Features

  • Authentication: The application is secured by JWT authentication method;
  • Authorization: Only authorized person can access the protected resources;
  • Payment-System: User can pay for the premium content;

Models:

  • User: name, email, role, password, status, profilePhoto, isVerified, followers, following;
  • Post: title, content, image, authorId, category, upvotes, downvotes, comments, isPremium;
  • Comment: content, authorId, postId;
  • Payment: email, userId, amount, status, transactionId, date;
  • Notification: userId, postId, message, type;

Endpoints:

  1. Sign Up: (POST) /api/auth/register;
  2. Sign In: (POST) /api/auth/login;
  3. Forget Password: (POST) /api/auth/forget-password;
  4. Reset Password: (POST) /api/auth/reset-password;
  5. Post: (POST) /api/post, (GET) /api/post, (GET) /api/post/:id, (PUT) /api/post/:id, (DELETE) /api/post/:id, (GET) /api/users/my-post/:email , (POST) /api/:post/upvote, (POST) /api/:post/downvote;
  6. Comment: (POST) /api/comment, (PUT) /api/comment/:id, (DELETE) /api/comment/:id;
  7. Payment: (POST) /api/initiate-payment, (POST) /api/confirmation;
  8. User: (GET) /api/users/:email, (PUT) /api/users/:email, (POST) /api/users/follow, (POST) /api/users/unfollow;
  9. Notification: (GET) /api/notification/:userId, (DELETE) /api/notification/:userId/:postId;
  10. Anaylatics:

How to run the application locally

  1. Clone the repository
https://github.com/Khairul-islam98/tech-tips-hub-backend.git
  1. Project open
cd tech-tips-hub-backend
  1. install the required packages
npm i
  1. Add a .env file
NODE_ENV=development
PORT=5000
DATABASE_URL=
JWT_ACCESS_SECRET=
JWT_ACCESS_SECRET_EXPIRE=
BCRYPT_SALT_ROUND=
RESET_PASS_UI_LINK=
EMAIL_USER=
EMAIL_PASS=
STORE_ID=
SIGNATURE_KEY=
PAYMENT_URL=
PAYMENT_VERIFY_URL=
  1. Run the Application locally
npm run start:dev