Node Kickstart

Kickstart your Node.js project with a robust, clean architecture and all the essential tools you need! This starter kit is designed to help you create scalable, maintainable, and production-ready applications in no time.

Features

• 🚀 Express.js: Fast, minimalist web framework for Node.js. Express.js
• 🏷️ TypeScript: Typed JavaScript at its best for enhanced development. TypeScript
• 🛠️ PRISMA: A modern database toolkit for PostgreSQL, MySQL, and SQLite. PRISMA
• 🚨 ESLint: A pluggable linter for JavaScript and TypeScript. ESLint
• 💅 Prettier: Opinionated code formatter to ensure code consistency. Prettier
• ⚓ Husky: Git hooks made easy for better code quality. Husky
• ✅ Jest: Delightful JavaScript Testing for Node.js projects. Jest
• 👀 Cypress: Fast, easy, and reliable end-to-end testing for anything that runs in a browser. Cypress
• 📦 Yup: Schema validation for API input data. Yup
• ♉ Helmet: Helps secure your Express applications by setting various HTTP headers. Helmet
• 🔊 Morgan: HTTP request logger middleware for Node.js. Morgan
• 🏗️ Clean Architecture: A well-structured project layout for maintainability.
• ⁉️ Error Handling: Robust error handling to improve reliability.
• ✨ Clean Code: Follows best practices and clean code principles.
• 📋 Example API (todos): Includes an example API for managing todo items.

Getting Started

Prerequisites

Ensure you have the following installed:

• Node.js
• Yarn

Setup

1. Clone the repository:

git clone https://github.com/samiur-r/node-kickstart
cd node-kickstart

2. Install dependencies:

yarn install

3. Copy the env.example file to .env::

 cp .env.example .env

4. Start the development server:

yarn run dev

Build

Builds the production application

yarn run build

Starts the application in production mode.

yarn run start

Testing

Unit Testing with Jest

yarn run test:unit

E2E Testing with cypress

yarn run test:e2e:open
yarn run test:e2e:run

Linting and Formatting

Lint your code with ESLint:

yarn lint

Format your code with Prettier:

yarn format

Contributing

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

Feedback

If you have any questions or feedback, feel free to contact us:

• Email: samiur.rahman.akif@gmail.com
• GitHub Issues: https://github.com/samiur-r/node-kickstart.git/issues

License

This project is open source and available under the MIT License.