Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taeyoonkwon/typescript-express-boilerplate
Production ready typescript express boilerplate
https://github.com/taeyoonkwon/typescript-express-boilerplate
boilerplate express jest jwt mongodb mongoose nodejs openapi rest-api template typescript
Last synced: about 1 month ago
JSON representation
Production ready typescript express boilerplate
- Host: GitHub
- URL: https://github.com/taeyoonkwon/typescript-express-boilerplate
- Owner: TaeyoonKwon
- License: mit
- Created: 2022-05-26T06:29:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-14T10:49:55.000Z (over 2 years ago)
- Last Synced: 2024-11-06T01:49:30.817Z (3 months ago)
- Topics: boilerplate, express, jest, jwt, mongodb, mongoose, nodejs, openapi, rest-api, template, typescript
- Language: TypeScript
- Homepage:
- Size: 160 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Typescript Express Boilerplate
[](https://github.com/TaeyoonKwon/typescript-express-boilerplate/actions/workflows/ci.yaml)
Production ready boilerplate project made with Typescript and Express.
## đ Features
- Typescript, ESLint, and Prettier configurations.
- Open API 3 documentation with Swagger UI.
- MongoDB object modeling using Mongoose.
- CRUD API routes with an example MongoDB model.
- Middlewares using API KEY and Bearer Token.
- User authentication using JWT and password encryption.
- Jest unit testing.
- Dockerfile example.
## đ§ Building and Testing
âšī¸ _You should create your own `.env` file to run it._
### Install packages
> npm install
### Build
> npm run build
### Dev mode
> npm run dev
### Production mode
> npm start
### Unit testing
> npm run test
## đ License
[MIT](https://github.com/TaeyoonKwon/typescript-express-boilerplate/blob/main/LICENSE) Copyright (c) 2022 Taeyoon Kwon