Awesome
<h1 align="center"> <br> <img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/logo.jpg" alt="Project Logo" /> <br> <br> TypeScript Express Starter <br> </h1> <h4 align="center">๐ Express RESTful API Boilerplate Using TypeScript</h4> <p align ="center"> <a href="https://nodei.co/npm/typescript-express-starter" target="_blank"> <img src="https://nodei.co/npm/typescript-express-starter.png" alt="npm Info" /> </a> </p> <p align="center"> <a href="http://npm.im/typescript-express-starter" target="_blank"> <img src="https://img.shields.io/npm/v/typescript-express-starter.svg" alt="npm Version" /> </a> <a href="http://npm.im/typescript-express-starter" target="_blank"> <img src="https://img.shields.io/github/v/release/ljlm0402/typescript-express-starter" alt="npm Release Version" /> </a> <a href="http://npm.im/typescript-express-starter" target="_blank"> <img src="https://img.shields.io/npm/dm/typescript-express-starter.svg" alt="npm Downloads" /> </a> <a href="http://npm.im/typescript-express-starter" target="_blank"> <img src="https://img.shields.io/npm/l/typescript-express-starter.svg" alt="npm Package License" /> </a> </p> <p align="center"> <a href="https://github.com/ljlm0402/typescript-express-starter/stargazers" target="_blank"> <img src="https://img.shields.io/github/stars/ljlm0402/typescript-express-starter" alt="github Stars" /> </a> <a href="https://github.com/ljlm0402/typescript-express-starter/network/members" target="_blank"> <img src="https://img.shields.io/github/forks/ljlm0402/typescript-express-starter" alt="github Forks" /> </a> <a href="https://github.com/ljlm0402/typescript-express-starter/stargazers" target="_blank"> <img src="https://img.shields.io/github/contributors/ljlm0402/typescript-express-starter" alt="github Contributors" /> </a> <a href="https://github.com/ljlm0402/typescript-express-starter/issues" target="_blank"> <img src="https://img.shields.io/github/issues/ljlm0402/typescript-express-starter" alt="github Issues" /> </a> </p> <br /> <br />๐ 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
<img src="https://github.com/ljlm0402/typescript-express-starter/raw/images/cli.gif" alt="Example Cli" />Start your typescript-express-starter app in development mode at http://localhost:3000/
Template Type
Name | Description |
---|---|
Default | Express Default |
Routing Controllers | Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage |
Sequelize | Easy to use multi SQL dialect ORM 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 | query language for APIs and a runtime for fulfilling those queries with your existing data |
Typegoose | Define Mongoose models using TypeScript classes |
Mikro ORM | TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL and SQLite databases |
Node Postgres | node-postgres is a collection of node.js modules for interfacing with your PostgreSQL database |
Template to be developed
Name | Description |
---|---|
Sequelize Typescript | Decorators and some other features for sequelize |
TS SQL | A SQL database implemented purely in TypeScript type annotations |
inversify-express-utils | Some utilities for the development of Express application with InversifyJS |
postgress typescript | |
graphql prisma |
๐ Available Commands for the Server
- Run the Server in production mode :
npm run start
orStart typescript-express-starter
in VS Code - Run the Server in development mode :
npm run dev
orDev typescript-express-starter
in VS Code - Run all unit-tests :
npm test
orTest typescript-express-starter
in VS Code - Check for linting errors :
npm run lint
orLint typescript-express-starter
in VS Code - Fix for linting :
npm run lint:fix
orLint:Fix typescript-express-starter
in VS Code
๐ The Package Features
<p> <img src="https://img.shields.io/badge/-TypeScript-007ACC?style=for-the-badge&logo=TypeScript&logoColor=fff" /> <img src="https://img.shields.io/badge/-Node.js-339933?style=for-the-badge&logo=Node.js&logoColor=fff" /> <img src="https://img.shields.io/badge/-NPM-CB3837?style=for-the-badge&logo=NPM&logoColor=fff" /> </p> <p> <img src="https://img.shields.io/badge/-Docker-2496ED?style=for-the-badge&logo=Docker&logoColor=fff" /> <img src="https://img.shields.io/badge/-NGINX-269539?style=for-the-badge&logo=NGINX&logoColor=fff" /> <img src="https://img.shields.io/badge/-PM2-2B037A?style=for-the-badge&logo=PM2&logoColor=fff" /> <img src="https://img.shields.io/badge/-Nodemon-76D04B?style=for-the-badge&logo=Nodemon&logoColor=fff" /> <img src="https://img.shields.io/badge/-ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=fff" /> <img src="https://img.shields.io/badge/-Prettier-F7B93E?style=for-the-badge&logo=Prettier&logoColor=000" /> <img src="https://img.shields.io/badge/-Jest-C21325?style=for-the-badge&logo=Jest&logoColor=fff" /> <img src="https://img.shields.io/badge/-Swagger-85EA2D?style=for-the-badge&logo=Swagger&logoColor=000" /> <img src="https://img.shields.io/badge/-SWC-FFFFFF?style=for-the-badge&logo=swc&logoColor=FBE1A6" /> </p> <p> <img src="https://img.shields.io/badge/-MySQL-4479A1?style=for-the-badge&logo=MySQL&logoColor=fff" /> <img src="https://img.shields.io/badge/-MariaDB-003545?style=for-the-badge&logo=MariaDB&logoColor=fff" /> <img src="https://img.shields.io/badge/-PostgreSQL-336791?style=for-the-badge&logo=PostgreSQL&logoColor=fff" /> <img src="https://img.shields.io/badge/-MongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=fff" /> </p>๐ณ 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.
-
CMD
+Shift
+P
(Mac Os) orCtrl
+Shift
+P
(Windows) -
Format Selection With
-
Configure Default Formatter...
-
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
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
orpm2 start ecosystem.config.js --only prod
- development mode ::
npm run deploy:dev
orpm2 start ecosystem.config.js --only dev
Modify ecosystem.config.js
file to your source code.
๐ SWC :: a super-fast JavaScript / TypeScript compiler
SWC is an extensible Rust-based platform for the next generation of fast developer tools.
SWC is 20x faster than Babel on a single thread and 70x faster on four cores.
- tsc build ::
npm run build
- swc build ::
npm run build:swc
Modify .swcrc
file to your source code.
๐ Makefile :: This is a setting file of the make program used to make the compilation that occurs repeatedly on Linux
Makefiles are used to help decide which parts of a large program need to be recompiled.
- help ::
make help
Modify Makefile
file to your source code.
๐ Code Structure (default)
โ
โโโ๐ .vscode
โ โโโ launch.json
โ โโโ settings.json
โ
โโโ๐ src
โ โโโ๐ config
โ โ โโโ index.ts
โ โ
โ โโโ๐ controllers
โ โ โโโ auth.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
โ โ โโโ users.route.ts
โ โ
โ โโโ๐ services
โ โ โโโ auth.service.ts
โ โ โโโ users.service.ts
โ โ
โ โโโ๐ test
โ โ โโโ auth.test.ts
โ โ โโโ users.test.ts
โ โ
โ โโโ๐ utils
โ โ โโโ logger.ts
โ โ โโโ vaildateEnv.ts
โ โ
โ โโโ app.ts
โ โโโ server.ts
โ
โโโ .dockerignore
โโโ .editorconfig
โโโ .env.development.local
โโโ .env.production.local
โโโ .env.test.local
โโโ .eslintignore
โโโ .eslintrc
โโโ .gitignore
โโโ .huskyrc
โโโ .lintstagedrc.json
โโโ .prettierrc
โโโ .swcrc
โโโ docker-compose.yml
โโโ Dockerfile.dev
โโโ Dockerfile.prod
โโโ ecosystem.config.js
โโโ jest.config.js
โโโ Makefile
โโโ nginx.conf
โโโ nodemon.json
โโโ package-lock.json
โโโ package.json
โโโ swagger.yaml
โโโ tsconfig.json
โญ๏ธ Stargazers
๐ด Forkers
๐ค Contributors
๐ณ License
๐ 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
Please leave a question or question as an issue.
I will do my best to answer and reflect.
Thank you for your interest.