Welcome to the NodeExpress API project, a powerful solution for building RESTful APIs using Node.js, Express, Prisma ORM, MongoDB, and JWT Authentication. This project is designed to help you create a robust API for an imaginary ChangeLog app, enabling seamless product update management.
Design and build APIs from the ground up in Node.js! Use Express to handle routes and create your REST API. You'll read and update data from a MongoDB database using Prisma and TypeScript. Additionally, enhance the security of your API by implementing JWT authentication.
We have carefully crafted a database schema to support the functionalities of our ChangeLog app. The schema includes models such as Update
, Update Point
, Feature
, and standard user information.
We aim to create a reliable and scalable API to serve as the backend for our ChangeLog app. While we won't be building a UI in this project, the API is designed to handle essential operations such as reading, creating, updating, and deleting product updates.
- Node.js: A runtime that leverages JavaScript, providing a rich and active ecosystem.
- Express: A powerful web application framework for Node.js, making API development efficient and organized.
- Prisma ORM: A tool for designing the database according to our needs, handling schemas, queries, and migrations.
- MongoDB: A flexible and scalable NoSQL database. Prisma interacts seamlessly with MongoDB.
- Render: A platform that simplifies the hosting of Node.js-based APIs, providing ease of deployment.
- Deployed API Link: NodeExpress-Prisma-Mongo-TS-JWT-API
- Postman Collection: Postman Collection
Note: The Postman collection provides detailed requests for user, product, update, and update point. Make sure to sign in before accessing protected routes.
Explore the MongoDB database schema and sample data using Prisma Studio. Run the following command:
prisma studio
This will open a web page showcasing your database schema. It looks like 👇
- Fork the repository to your GitHub account.
- Clone the forked repository to your local machine.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature
orgit checkout -b bugfix/your-bugfix
. - Make your changes and test thoroughly.
- Commit your changes:
git commit -m "Your meaningful commit message"
. - Push to your branch:
git push origin feature/your-feature
orgit push origin bugfix/your-bugfix
. - Open a pull request (PR) against the
main
branch.
Happy Coding ❤️