Giter Club home page Giter Club logo

adomne / express-ts-jest-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 504 KB

Express Application Boilerplate. Application written in TypeScript with ESLint, Prettier, Husky, Jest support, PM2 Monitoring, and CI/CD out of the box.

Home Page: https://www.npmjs.com/package/@adomne/express-ts-jest-boilerplate

License: Apache License 2.0

JavaScript 54.30% Shell 1.20% Dockerfile 3.03% TypeScript 41.47%
typescript nodejs node node-js express expressjs express-js jest jest-tests husky pm2 ci-cd eslint prettier node-typescript node-typescript-boilerplate morgan-middleware helmet

express-ts-jest-boilerplate's Introduction

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

  • express
  • express-actuator
  • helmet
  • dotenv
  • cors
  • mongoose
  • morgan

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 .husky folder.



Follow us on Twitter, Instagram, Linkedin, and Github.

express-ts-jest-boilerplate's People

Contributors

elhe26 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.