Express with TypeScript's Starter.

🇰🇷 Korean

🤔 What is Express ?

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

😎 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 by seanpmaxwell 👍

🚀 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

🛎 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

• Fix for linting :

  npm run lint:fix

💎 The Package Features

Simple Icons

🐳 Docker - Containers

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 - Reverse Proxy

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

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.

ESLint, Find and fix problems in your JavaScript code

Prettier is an opinionated code formatter.

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

📗 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(VSCode Extension) - 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

🗂 Code Structure (default)

│
├── /.vscode
│   └── settings.json
│
├── /src
│   ├── /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
├── .prettierrc
├── docker-compose.yml
├── Dockerfile
├── Dockerfile.dev
├── jest.config.js
├── Makefile
├── Makefile
├── nginx.conf
├── nodemon.json
├── package-lock.json
├── package.json
├── swagger.yaml
└── tsconfig.json

📬 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 |

💳 License

MIT

🤝 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

📬 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. ( ･∀･)ﾉｼ