Skip to content

This project is an implementation of Clean Architecture using Express and TypeScript. The goal is to create an application structure that is modular, easy to understand, and easy to develop.

License

Notifications You must be signed in to change notification settings

bangadam/express-typescript-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Express TypeScript Clean Architecture

License Dependencies

This project is an implementation of Clean Architecture using Express and TypeScript. The goal is to create an application structure that is modular, easy to understand, and easy to develop.

Features

  • Express Server: Web server using Express.js.
  • TypeScript: Utilizes TypeScript for safer and more structured code.
  • Clean Architecture: Separates code into several layers (domain, application, infrastructure, presentation) to maintain separation of concerns.

Project Structure

express-ts-clean-arch/
├── src/
│   ├── domain/
│   ├── application/
│   ├── infrastructure/
│   └── presentation/
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── yarn.lock

Installation

Ensure you have Node.js and Yarn installed on your system.

  1. Clone the repository:

    git clone https://github.com/bangadam/express-ts-clean-arch.git
  2. Navigate to the project directory:

    cd express-ts-clean-arch
  3. Install dependencies:

    yarn install

Configuration

  1. Make sure the .env file is properly configured. Example:

    PORT=9000
  2. Database configuration can be found at:

    src/application/helpers/databaseConfiguration.ts
    

    Adjust the settings according to your environment.

Running the Application

Run the following command to start the application:

yarn start

The application will run at http://localhost:9000.

Additional Scripts

  • yarn build: Build the TypeScript application into JavaScript.
  • yarn dev: Run the application with nodemon for development.

Contribution

Contributions are welcome. Please create an issue or pull request for improvements and new features.

License

This project is licensed under the MIT License.

About

This project is an implementation of Clean Architecture using Express and TypeScript. The goal is to create an application structure that is modular, easy to understand, and easy to develop.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published