This project is a scalable, well-structured Node.js backend built with TypeScript. It's designed to handle the complexity and scale of modern applications, while being optimized for different environments.
The codebase follows best practices for Node.js development, with a logical directory structure organized by functionality and type, ensuring maintainability and clarity.
- TypeScript: Enhances development with static typing, leading to more reliable and maintainable code.
- Request Limiter: Prevents abuse or overload of routes by limiting request rates, enhancing security.
- Centralized Error Handling: Streamlines error management and maintains a consistent user experience.
- API Versioning: Organizes routes and ensures compatibility, preventing breaking changes for existing clients.
- Role-Based Access Control: Provides fine-grained access management based on user roles.
- JWT Authentication: Secures user authentication and authorization using JSON Web Tokens.
- Password Reset via Email: Enhances account security and recovery options through email notifications.
- MongoDB with Mongoose: Utilizes MongoDB for its speed and scalability, with Mongoose simplifying database interactions.
- ESLint: Enforces coding standards and best practices for improved code quality.
- Prettier: Formats code consistently according to predefined rules.
- Cookies for Tokens: Uses cookies to store tokens securely, improving authentication and session management.
- Logging: Utilizes Winston for robust and flexible logging, aiding in debugging and monitoring.
- Middleware for Exception Handling: Improves error management within async Express routes.
- Swagger (OpenAPI): Automatically generates API documentation, allowing easy access to all available endpoints and their descriptions.
- Node.js
- Express.js
- Typescript
- Mongoose
- MongoDb
- Joi
- JWT
- Cookies
- Winston
- Rate Limiter
- Roles
- Nodemailer
- Docker image (API Image)
- Swagger (OpenAPI)
To test email functionality, use Mailtrap: Mailtrap. Create your credentials and place them in the .env file under Mailtrap (Email Service) Info.
- Clone the repository and navigate to the root directory in your terminal.
- Install the project dependencies by running the following command:
npm run install:packages- Duplicate the
.env.examplefile and save the copy as.envin the server directory. Modify the variables as needed.
- After installing the dependencies, you can either:
- Go to the
package.jsonfile and click on the play button next to thewatchscript under the "scripts" section. - Or, run the following command in your terminal:
- Go to the
npm run watchhttp://localhost:3001/api/v1/To access the interactive Swagger documentation for the API, navigate to:
http://localhost:3001/api-docs/v1/This will open a web page where you can view and interact with all available API endpoints. Swagger allows you to explore the API, see request and response formats, and even make requests directly from the interface.
You can test the API routes using Postman. Follow these steps:
- Ensure Postman is installed.
- Start the server and verify it's running on the correct port.
- To generate a secret token and refresh token for the
.envfile, open your terminal and run:
node- Then, in the Node.js REPL:
require('crypto').randomBytes(64).toString('hex')- Ensure Docker is installed on your computer.
- Copy or rename the
.env.examplefile to.env, and fill in the required values based on your environment. Additionally, you may update the necessary values in the docker-compose.yml file as required. - Open your terminal.
- Run the following command:
docker-compose up -dThis command will fetch all necessary libraries and dependencies, set up the environment, and start the services as defined in your docker-compose.yml file. Follow any additional setup or configuration instructions provided in the README file.
- Email Verification (Account Activation)
- Implement Testing: Add comprehensive unit and integration tests to ensure code reliability and maintainability.