materkel/typescript-express-starter

🚀 TypeScript Express Starter

Express with TypeScript's Starter.

🤔 What is Express ?

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

😎 Introducing the package.

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.

NOTE: This project is a variation of 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"

Choose the template you want. We will create more templates later.

Select a templates

Start your typescript-express-starter app in development mode at http://localhost:3000/

$ cd "project name" && npm run start

🛎 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.

🗂 Code Structure (default)

│
├── /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
│   │   ├── util.ts
│   │   └── vaildateEnv.ts
│   │
│   ├── app.ts
│   └── server.ts
│
├── .env
├── .gitignore
├── jest.config.js
├── package-lock.json
├── package.json
├── swagger.yaml
├── tsconfig.json
└── tslint.json

📗 Swagger UI Docs

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

Find out how Swagger can help you design and document your APIs at scale.

Start your typescript-express-starter app in development mode at http://localhost:3000/swagger

Modify swagger.yaml file to your source code

🌐 REST Client

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

VSCode Extension REST Client Install.

📬 Recommended Commit Message

When	Commit Message
Add function	feat: ⚡️ Add function
Fix bug	fix: 🐞 Fix bug
Refactoring	refactor: 🛠 Refactoring
Add package	package: 📦 Add package
Fix readme	docs: 📚 Fix readme
Improvements style	style: 👁 Improvements style
New Releases	releases: 🎉 Releases

💳 License

MIT

🤝 Contributors

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

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

• BitYoungjae https://github.com/BitYoungjae

• strama4 https://github.com/strama4

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

• sonbyungjun https://github.com/sonbyungjun

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

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

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

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

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