A lightweight boilerplate for building scalable Node.js applications using TypeScript. Perfect for rapid development and adhering to best practices!
- TypeScript: Strong typing for better code quality.
- Express: Fast and minimalist web framework.
- ESLint & Prettier: Maintain code quality and style.
- Jest: Easy testing for reliability.
- dotenv-flow: Manage environment variables effortlessly.
- Mongoose: Simplified MongoDB interactions.
- Winston: Comprehensive logging.
-
Clone the repo:
git clone https://github.com/yourusername/base_server.git cd base_server
-
Install dependencies:
npm install
-
Set up environment files: Copy
.env.example
and configure. -
Start development:
npm run start:dev
- Build:
npm run build
- Compile TypeScript. - Test:
npm run test
- Run tests. - Lint:
npm run lint
- Check code for issues. - Fix Linting:
npm run lint:fix
- Automatically fix lint issues. - Format Check:
npm run format:check
- Check code formatting. - Fix Formatting:
npm run format:fix
- Automatically fix formatting. - Migrate Dev:
npm run migrate:dev
- Run development migrations. - Migrate Prod:
npm run migrate:prod
- Run production migrations. - Dockerize Dev:
npm run dockerize:dev
- Build Docker image for development.
Contributions are welcome! Fork the repo and submit a pull request.
MIT License