Express is a fast, open and concise web framework and is a Node.js based 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 π
$ npm install -g typescript-express-starter
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"
Start your typescript-express-starter app in development mode at http://localhost:3000/
Name | Desc |
---|---|
Default | Express Default |
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 (Developing) | 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 |
- 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 run 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
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 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.
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.
-
CMD
+Shift
+P
(Mac Os) orCtrl
+Shift
+P
(Windows) -
Format Selection With
-
Configure Default Formatter...
-
Prettier - Code formatter
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 allows you to send HTTP request and view the response in Visual Studio Code directly.
VSCode Extension REST Client Install.
Modify *.http
file in http folder to your source code.
β
βββ /.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
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 |
-
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
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. ( ο½₯βο½₯)οΎο½Ό