Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.36 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.36 KB

MarkItI 📘🔒

This project is a bookmark management API built with NestJS, Docker, PostgreSQL, and JWT authentication. It provides user registration, login, and the ability to manage bookmarks with JWT token-based authentication.

Features 🚀

  • User Registration: Users can sign up for an account by providing their details. ✍️
  • User Login: Registered users can log in to their accounts using their credentials. 🔐
  • JWT Authentication: JSON Web Tokens (JWT) are used for user authentication and authorization. 🔑
  • Edit User Details: Authenticated users can update their profile information. 🔄
  • Add User Bookmarks: Authenticated users can add bookmarks with information such as course title, link, and description. 📚
  • CRUD Operations on Bookmarks: Authenticated users can perform CRUD operations (Create, Read, Update, Delete) on their bookmarks using JWT tokens. 🔄📚

Requirements ⚙️

  • Node.js (v14 or above) 🚀
  • Docker 🐳
  • NestJS 🦸‍♂️

Contributing 🤝

Contributions are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository. 🍴
  2. Create a new branch: git checkout -b my-feature. 🌿
  3. Make your changes and commit them: git commit -am 'Add new feature'. 💻
  4. Push the changes to your fork: git push origin my-feature. 🚀
  5. Submit a pull request detailing your change. 📥