TypeScript Express Starter

🚀 Express RESTful API Boilerplate Using TypeScript

Translations - read in your own language

• 🇺🇸 English
• 🇰🇷 Korean

Want to translate to your own language? please open an issue 💜

Web Site - Project Introduction

• 💁🏻‍♂️ Dylan Iqbal :: A TypeScript Express Starter App

Want to be featured on your blog or site? please open an issue 💙

😎 Introducing The Project

Express consists of JavaScript, which makes it vulnerable to type definitions.

That's why we avoid supersets with starter packages that introduce TypeScript.

The package is configured to use TypeScript instead of JavaScript.

The project referred to express-generator-typescript

🤔 What is Express ?

Express is a fast, open and concise web framework and is a Node.js based project.

🚀 Quick Start

Install with the npm Global Package

$ npm install -g typescript-express-starter

Run npx to Install The Package

npx is a tool in the JavaScript package management module, npm.

This is a tool that allows you to run the npm package on a single run without installing the package.

If you do not enter a project name, it defaults to typescript-express-starter.

$ npx typescript-express-starter "project name"

Select a Templates

Start your typescript-express-starter app in development mode at

http://localhost:3000/

Template Type

| Name | Desc | | :------------------- | :----------------------------------------------------------------------------------------------------------- | | Default | Express Default | | Routing Controllers | Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage | | Sequlize | Easy to use multi SQL dialect ROM for Node.js | | Mongoose | MongoDB Object Modeling(ODM) designed to work in an asynchronous environment | | TypeORM | An ORM that can run in Node.js and Others | | Prisma | Modern Database Access for TypeScript & Node.js | | Knex | SQL query builder for Postgres, MySQL, MariaDB, SQLite3 and Oracle | | GraphQL (Developing) | query language for APIs and a runtime for fulfilling those queries with your existing data |

🛎 Available Commands for the Server

• Run the Server in production mode :

  npm run start

  or

  Start typescript-express-starter

  in VS Code
• Run the Server in development mode :

  npm run dev

  or

  Dev typescript-express-starter

  in VS Code
• Run all unit-tests :

  npm run test

  or

  Test typescript-express-starter

  in VS Code
• Check for linting errors :

  npm run lint

  or

  Lint typescript-express-starter

  in VS Code
• Fix for linting :

  npm run lint:fix

  or

  Lint:Fix typescript-express-starter

  in VS Code

💎 The Package Features

• Application

  • 

• DevOps

  • 

• Utilities

  • 

• Database

  • 

Simple Icons

🐳 Docker :: Container Platform

Docker is a platform for developers and sysadmins to build, run, and share applications with containers.

Docker Install.

• starts the containers in the background and leaves them running :

  docker-compose up -d

• Stops containers and removes containers, networks, volumes, and images :

  docker-compose down

Modify

docker-compose.yml

Dockerfile

♻️ NGINX :: Web Server

NGINX is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache.

Proxying is typically used to distribute the load among several servers, seamlessly show content from different websites, or pass requests for processing to application servers over protocols other than HTTP.

When NGINX proxies a request, it sends the request to a specified proxied server, fetches the response, and sends it back to the client.

Modify

nginx.conf

✨ ESLint, Prettier :: Code Formatter

Prettier is an opinionated code formatter.

ESLint, Find and fix problems in your JavaScript code

It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.

1. Install VSCode Extension Prettier, ESLint

2. CMD

   +

   Shift

   +

   P

   (Mac Os) or

   Ctrl

   +

   Shift

   +

   P

   (Windows)

3. Format Selection With

4. Configure Default Formatter...

5. Prettier - Code formatter

Palantir, the backers behind TSLint announced in 2019 that they would be deprecating TSLint in favor of supporting typescript-eslint in order to benefit the community. So, migration from TSLint to ESLint.

📗 Swagger :: API Document

Swagger is Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset.

Easily used by Swagger to design and document APIs at scale.

Start your app in development mode at

http://localhost:3000/api-docs

Modify

swagger.yaml

🌐 REST Client :: HTTP Client Tools

REST Client allows you to send HTTP request and view the response in Visual Studio Code directly.

VSCode Extension REST Client Install.

Modify

*.http

🔮 PM2 :: Advanced, Production process manager for Node.js

PM2 is a daemon process manager that will help you manage and keep your application online 24/7.

• production mode ::

  npm run deploy:prod

  or

  pm2 start ecosystem.config.js --only prod

• development mode ::

  npm run deploy:dev

  or

  pm2 start ecosystem.config.js --only dev

Modify

ecosystem.config.js

🗂 Code Structure (default)

│
├── /.vscode
│   ├── launch.json
│   └── settings.json
│
├── /src
│   ├── /configs
│   │   ├── development.json
│   │   ├── production.json
│   │   └── test.json
│   │
│   ├── /controllers
│   │   ├── auth.controller.ts
│   │   ├── index.controller.ts
│   │   └── users.controller.ts
│   │
│   ├── /dtos
│   │   └── users.dto.ts
│   │
│   ├── /exceptions
│   │   └── HttpException.ts
│   │
│   ├── /http
│   │   ├── auth.http
│   │   └── users.http
│   │
│   ├── /interfaces
│   │   ├── auth.interface.ts
│   │   ├── routes.interface.ts
│   │   └── users.interface.ts
│   │
│   ├── /middlewares
│   │   ├── auth.middleware.ts
│   │   ├── error.middleware.ts
│   │   └── validation.middleware.ts
│   │
│   ├── /models
│   │   └── users.model.ts
│   │
│   ├── /routes
│   │   ├── auth.route.ts
│   │   ├── index.route.ts
│   │   └── users.route.ts
│   │
│   ├── /services
│   │   ├── auth.service.ts
│   │   └── users.service.ts
│   │
│   ├── /tests
│   │   ├── auth.test.ts
│   │   ├── index.test.ts
│   │   └── users.test.ts
│   │
│   ├── /utils
│   │   ├── logger.ts
│   │   ├── util.ts
│   │   └── vaildateEnv.ts
│   │
│   ├── app.ts
│   └── server.ts
│
├── .dockerignore
├── .editorconfig
├── .env
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .huskyrc
├── .lintstagedrc.json
├── .prettierrc
├── docker-compose.yml
├── Dockerfile
├── ecosystem.config.js
├── jest.config.js
├── Makefile
├── nginx.conf
├── nodemon.json
├── package-lock.json
├── package.json
├── swagger.yaml
└── tsconfig.json

⭐️ Stargazers

🍴 Forkers

🤝 Contributors

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

• João Silva https://github.com/joaopms

• BitYoungjae https://github.com/BitYoungjae

• Paolo Tagliani https://github.com/pablosproject

• Lloyd Park https://github.com/yeondam88

• strama4 https://github.com/strama4

• sonbyungjun https://github.com/sonbyungjun

• Sean Maxwell https://github.com/seanpmaxwell

• Ed Guy https://github.com/edguy3

• Malavan https://github.com/malavancs

• Jon Gallant https://github.com/jongio

• Kuba Rozkwitalski https://github.com/kubarozkwitalski

• Craig Harman https://github.com/craigharman

• Edward Teixeira Dias Junior https://github.com/edward-teixeira

• n2ptune https://github.com/n2ptune

• michael r https://github.com/alanmynah

• Benjamin https://github.com/benjaminudoh10

• Amrik Singh https://github.com/AmrikSD

💳 License

MIT

📬 Recommended Commit Message

| When | Commit Message | | :--------------- | :----------------- | | Add Feature | ✨ Add Feature | | Fix Bug | 🐞 Fix Bug | | Refactoring Code | 🛠 Refactoring Code | | Install Package | 📦 Install Package | | Fix Readme | 📚 Fix Readme | | Update Version | 🌼 Update Version | | New Template | 🎉 New Template |

📬 Please request an issue

In the future, please write down your desired template, questions, and features to be added, and we will try our best to answer and reflect them.

Thank you very much for your interest in our package.

(๑˃̵ᴗ˂̵)و