1.0.4 • Published 2 years ago
@adomne/express-ts-jest-boilerplate v1.0.4
Express-Typescript-Jest-Boilerplate
Skeleton for Express.js applications written in TypeScript with testing support and CI/CD out of the box.
Purpose
The main purpose of this Skeleton is to start an Express Application with typescript, testing support and default CI/CD configuration.
Common Features
- Integrated eslint, prettier, jest, and husky.
- CI/CD Configuration by default.
- Simple and Standard scaffolding.
- Based on Typescript Syntax.
- Integrated morgan logger.
- Test cases Support.
Core NPM Modules
expressexpress-actuatorhelmetdotenvcorsmongoosemorgan
Set Application
- Install using
npx @adomne/express-ts-jest-boilerplate my-own-starter-project
OR
- Clone the Application
git clone https://github.com/adomne/express-ts-jest-boilerplate.git - Install the dependencies
npm install
Project Structure
| Name | Description |
|---|---|
| .husky/ | Git hooks configuration |
| .github/ | Github actions configuration |
| .vscode/ | Launch options for jest (using Jest ext from orta) |
| api/ | Endpoint testing (using thunder client ext) |
| config/ | Environment files |
| CI/ | CI/CD configuration steps |
| dist/ | Compiled source files will be placed here |
| src/ | Source files |
| src/controllers | Business logic for routes |
| src/db | DB connectors |
| src/middleware/ | Middlewares like Async Handler feature |
| src/models | Model definitions |
| src/routers | Route definitions |
| src/services | 3rd party services |
| tests/ | Test cases will be placed here |
Default System Health Status API
${host}/info- Displays application information${host}/metrics- Shows metrics information for the current application.${host}/health- Shows application health information.
Notes
1. Husky Configuration files (pre-commit and pre-push)
- Check CONFIGURATION.md inside
.huskyfolder.