Overview:
This product is not a commercial project but rather a personal project designed to improve the developer’s knowledge. It is a live demo that showcases the use of various technologies, including React, Next.js, Typescript, PostCSS, Storybook, Nest.js, Express, MongoDB, Mongoose, and JSON Web Tokens (JWT). The project also provides a guide on how to use it, including setting up the necessary environment variables.
Features:
- Frontend: Built using React and Next.js
- Backend: Developed using Nest.js and Express
- Database: Utilizes MongoDB and Mongoose for database management
- Authentication: Implements JSON Web Tokens (JWT) for user authentication
- Storybook: Includes Storybook for UI component development and testing
- Swagger Interface: Provides a Swagger interface to interact with the backend API
Installation:
To install and use this project, follow the steps below:
- Clone the repository to your local machine.
- Navigate to the
serverdirectory within the cloned repository. - Create a
.envfile inside theserverdirectory and populate it with the necessary variables. - Start the application by running the appropriate commands for the frontend and backend separately.
For detailed instructions on setting up the MongoDB Atlas and configuring the environment variables, refer to the MongoDB Atlas documentation.
Summary:
This project serves as a demo that showcases the developer’s knowledge and implementation of various technologies. It includes a frontend built with React and Next.js, a backend developed using Nest.js and Express, and a MongoDB database managed with Mongoose. The project also incorporates JSON Web Tokens (JWT) for authentication and provides a Swagger interface for interacting with the backend API. Detailed installation instructions are provided, including setting up the necessary environment variables.