Awesome Open Source
Awesome Open Source


Project Logo

TypeScript Express Starter

๐Ÿš€ Express RESTful API Boilerplate Using TypeScript

npm Version npm Release Version npm Package License npm Downloads

github Stars github Forks github Contributors github Issues


Translations - read in your own language

Want to translate to your own language? please open an issue ๐Ÿ’œ


Web Site - Project Introduction

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

Example Cli

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 and Dockerfile file to your source code.

โ™ป๏ธ 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 file to your source code.

โœจ 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

Formatter Setting

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 file to your source code.

๐ŸŒ 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 file in src/http folder to your source code.

๐Ÿ”ฎ 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 file to your source code.

๐Ÿ—‚ 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

๐Ÿ“ฌ 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

Contributors

๐Ÿ“ฌ 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.

(เน‘หƒฬตแด—ห‚ฬต)ูˆ


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
typescript (12,087)ย 
nodejs (3,875)ย 
docker (2,978)ย 
express (511)ย 
nginx (503)ย 
npm (452)ย 
swagger (389)ย 
jest (290)ย 
eslint (263)ย 
mongoose (178)ย 
logger (137)ย 
prettier (107)ย 
typeorm (74)ย 
sequelize (67)ย 
jsonwebtoken (24)ย 
bcrypt (22)ย