Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 2.06 KB

README.MD

File metadata and controls

86 lines (63 loc) · 2.06 KB


express-ts-init

A boilerplate for Express.js using TypeScript to reduce manual setup time. Follow clean architecture best practice.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started

About The Project

express-ts-init is a repository that serves as a foundational boilerplate for building web applications using the Express.js framework and TypeScript. This repository is made with the intention to follow the best practice for clean architecture as well as type safety.

Installation

  1. Clone the repo

    git clone https://github.com/mikah13/express-ts-init.git
  2. Install NPM packages

    pnpm install
  3. Enter your environments variables in .env files

     # App's running environment
     NODE_ENV=
    
     # App's running port
     PORT=3000
    
     # Cors origin url
     CORS_ORIGIN=
    
  4. Run the project in development mode

    pnpm run dev