https://github.com/shuvoprogram/express-boilerplate-starter

📦 A starter npm package for Express.js projects with TypeScript, Express, Mongoose, ESLint, Prettier, Husky, and Zod.
https://github.com/shuvoprogram/express-boilerplate-starter

eslint expressjs http-status-code husky mongodb prettier typescript zod

Last synced: about 1 month ago
JSON representation

📦 A starter npm package for Express.js projects with TypeScript, Express, Mongoose, ESLint, Prettier, Husky, and Zod.

• Host: GitHub
• URL: https://github.com/shuvoprogram/express-boilerplate-starter
• Owner: ShuvoProgram
• License: apache-2.0
• Created: 2024-05-03T19:22:04.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-04T11:40:58.000Z (about 1 year ago)
• Last Synced: 2025-03-18T22:33:16.187Z (2 months ago)
• Topics: eslint, expressjs, http-status-code, husky, mongodb, prettier, typescript, zod
• Language: TypeScript
• Homepage:
• Size: 223 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Express Boilerplate Starter

Express Boilerplate Starter is a boilerplate project designed to help you quickly set up a new Express.js project with TypeScript. It includes pre-configured settings and dependencies for a seamless development experience.

## Table of Contents

- [Getting Started](#getting-started)

- [Usage](#usage)

- [Customization](#customization)

- [Custom Folder Structure](#custom-folder-structure)

- [Features](#features)

- [Contributing](#contributing)

- [Credits](#credits)

- [License](#license)

## Getting Started

To get started with Express Boilerplate Starter, follow these steps:

1. Use `npx` to create a new project based on the starter:

   ```sh

   npx express-boilerplate-starter your_project_name

   ```

   This command will create a new directory with the specified name (your_repo_name), set up the project inside it, and install all the dependencies.

2. Navigate into the newly created directory:

   ```sh

   cd your_project_name

   ```

3. Change some values in package.json to meet your project needs. You can modify the project name, description, author, and other configurations as necessary.

4. Create `.env` file using the provided example in `.env.example`.

5. Customize the README file to provide information specific to your project.

6. Start the development server:

   ```sh

   npm run dev

   ```

## Usage

After setting up your project, you can use the provided scripts and configuration to start developing your Express application. Here are the scripts below:

- **`npm run dev`:**  Start the development server with hot reloading.

- **`npm run start`:**  Run the production build of the project.

- **`npm run lint`:**  Run ESLint to lint TypeScript files.

- **`npm run lint:fix`:**  Run ESLint to lint TypeScript files and automatically fix fixable issues.

- **`npm run build`:**  Build the project for production.

- **`npm run prettier-watch`:**  Automatically format TypeScript files using Prettier on file change.

- **`npm run prettier:fix`:**  Format all TypeScript files using Prettier.

- **`npm run prepare`:**  Trigger Husky to set up Git hooks.

## Customization

Create Express Boilerplate Starter can be customized to fit your specific requirements. You can modify configuration files, add or remove features, and integrate additional libraries or tools as needed.

## Custom Folder Structure

The project follows a customized folder structure to organize its source code and resources efficiently. Here's an overview of the folder structure:

- **src/common/**: Contains common files and utilities used across the project, such as `jwtHelper.ts` for custom user authentication token utils and `sendResponse.ts` for fetch data.

- **src/app/modules/**: Contains resources organized by domain, with each resource folder containing `model.ts`, `interface.ts`, `controller.ts`, and `routes.ts` files for that specific resource.

- **src/app/middlewares/**: Contains middleware functions used in the Express application such as `authMiddleware.ts` for check valid user, `globalErrorHandler` for handle any error of api and `validateRequest` for check valid user input.

- **src/app/routes**: Contains routes are main file who integrate all individual routes.

- **src/config/index**: Contains config `index.ts` file are managing environment variables.

- **src/error/**: Contains error folder to handle api error.

- **src/interface**: Contains interface folder including to `catchAsync.ts` to handle api validation, `common.ts` to handle common uses function, `error.ts` are used to handle incoming api errors.

- **src/server.ts**: Entry point for the Express server.

- **src/app.ts**: Defines the Express application.

### Additional Files

- **.env.example**: Example environment variables file.

- **.gitignore**: Git ignore rules.

- **package.json**: Node.js dependencies and scripts.

- **README.md**: Project documentation.

- **tsconfig.json**: TypeScript configuration file.

This folder structure provides a clear organization for the project's source code and resources, making it easier to navigate and maintain as the project grows.

## Features

- **TypeScript Support:** Write your Express application using TypeScript for enhanced type safety and developer productivity.

- **Express.js Integration:** Utilize the powerful features of Express.js to build robust and scalable web applications.

- **Mongoose Integration:** Seamlessly connect your Express application to MongoDB databases using Mongoose for data modeling and interaction.

- **Nodemon Development:** Use Nodemon for automatic server restarts during development for a smooth development experience.

- **Prettier Formatting:** Maintain consistent code style and formatting with Prettier, an opinionated code formatter.

- **Husky Git Hooks:** Enforce code quality and standards with Husky pre-commit hooks for linting and formatting checks.

- **GitHub Actions CI:** Set up continuous integration with GitHub Actions to automate testing and deployment workflows.

## Contributing

Contributions to Create Express TypeScript Starter are welcome! To contribute, please follow these steps:

1. Fork the repository and create a new branch.

2. Make your changes and ensure that the code passes all tests.

3. Submit a pull request with a clear description of the changes you've made.

   

## Credits

Express Boilerplate Starter was created by [Safar Khan Shuvo](https://www.linkedin.com/in/shuvok/) and is maintained by the open-source community.

## License

Express Boilerplate Starter is licensed under the Apache-2.0 license.