Description

This boilerplate leverages NestJs, a progressive Node.js framework, for building efficient and scalable server-side applications. MySQL serves as the robust relational database for storing application data, while TypeORM acts as the ORM for seamless interaction between TypeScript code and the database. To manage user accounts and authentication, basic user and auth models are included, and Swagger provides a comprehensive API documentation and testing interface for development and collaboration.

Clone the repository:

$ git clone https://github.com/Axiean/nestjs-auth-boilerplate

Install dependencies:

$ cd nestjs-auth-boilerplate

$ npm install

Set up environment variables:

For convenience, a .env.development file is provided at the project's root. Replace the placeholder values with your actual database credentials and other necessary environment variables. Keep in mind to add your ENV files to .gitignore

Run the development server:

npm run start:dev

Access the API documentation:

Open your browser and navigate to http://localhost:3000/api to view the Swagger UI.

Contributing

Feel free to contribute to this boilerplate by submitting pull requests or reporting issues.

• Author - Vahid Aslani
• Email - [email protected]