Express-TypeScript

ExpressJS + TypeScript template

Dependencies

Core

• TypeScript - a language which builds on JavaScript, by adding static type definitions.
• ExpressJS - Fast, unopinionated, minimalist web framework for Node.js.
• express-async-errors - async / await support for ExpressJS.
• cors - node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.

Optional

• swagger-ui-express - allows you to serve auto-generated swagger-ui generated API docs from express, based on a swagger.yaml file.
• winston - logging library.
• yamljs - yaml parser, used for parsing swagger.yaml.

Tools

• prettier - it 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.
• nodemon - dev server with live reload support.
• ts-node - TypeScript execution and REPL for node, requied for Nodemon to work.

Commands

• npm run start - run JavaScript entry point (run build first)
• npm run build - compile TypeScript to JavaScript
• npm run dev - run TypeScript dev server with live reload
• npm run prettify - format all code using prettier

CI/CD

Github

Codeql analysis

This action runs GitHub's industry-leading static analysis engine, CodeQL, against a repository's source code to find security vulnerabilities. It then automatically uploads the results to GitHub so they can be displayed in the repository's security tab

Documentation

Docker publish container

This action pushes docker image to GitHub public ghcr.io container registry. After each commit container is published with latest tag. After new version release (git tag which matches vX.X.X) container is published with version tag (without v).

Requied secrets:

• IMAGE_NAME - docker image name.
• CR_PAT - personal access token.

Documentation

GitLab

This package is compatible with GitLab Auto DevOpts, it should be enabled in settings.

Deployment

Heroku