yeri-kim / typescript-express-starter

🚀 TypeScript Express Starter

Express with TypeScript's application generator.

🧐 What is it?

Creates a new typescript express application. application is configured to use TypeScript instead of plain JavaScript.

🤔 Why typescript-express-starter?

Node Js is great for the rapid development of web-projects, but is often neglected because of the lack of type safety. TypeScript solves this issue and (along with its linter file) can even make your code more robust than some other static languages like Java.

⚙️ Installation

$ npm install -g typescript-express-starter

🚀 Quick Start

The quickest way to get started is use npx and pass in the name of the project you want to create. If you don't specify a project name, the default typescript-express-starter will be used instead.

1. Create the app

$ npx typescript-express-starter "project name"

Choose the template you want. We will create more templates later.

2. Select a templates

? Select a templates (Use arrow keys)
> default
  mongoose
--------------------

Start your typescript-express-starter app in development mode at http://localhost:3000/

$ cd "project name" && npm run start

🎠 Available commands for the server.

• Run the Server in production mode : npm run start.
• Run the Server in development mode : npm run dev.
• Run all unit-tests: npm run test.
• Check for linting errors: npm run lint.

⛑ Code Structure (default)

│
├── /src
│   ├── /controllers
│   │   ├── index.controller.ts
│   │   └── users.controller.ts
│   │
│   ├── /dtos
│   │   └── user.dto.ts
│   │
│   ├── /exceptions
│   │   └── HttpException.ts
│   │
│   ├── /interfaces
│   │   ├── routes.interface.ts
│   │   └── user.interface.ts
│   │
│   ├── /middlewares
│   │   ├── error.middleware.ts
│   │   └── validation.middleware.ts
│   │
│   ├── /models
│   │   └── users.model.ts
│   │
│   ├── /routes
│   │   ├── index.route.ts
│   │   └── users.route.ts
│   │
│   ├── /services
│   │   └── user.service.ts
│   │
│   ├── /tests
│   │   ├── index.test.ts
│   │   └── users.test.ts
│   │
│   ├── /utils
│   │   ├── util.ts
│   │   └── vaildateEnv.ts
│   │
│   ├── app.ts
│   └── server.ts
│
├── .gitignore
├── jest.config.js
├── package-lock.json
├── package.json
├── tsconfig.json
└── tslint.json

License

MIT

Contributors

• Jeongwon Kim https://github.com/swtpumpkin