Tale152 / express-server-template

A template repository for an Express server, trying to provide a good architecture, good practices, CI and CD.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Express server template

I'm tired of spending a lot of time setting up an Express server whenever the need arises so here we are.
I've created this template repository primarily for myself, but I hope this might help other people save time as well; feel free to use this template for your awesome projects.

I've set things up adding everything I know trying to focus on best practices, code quality, maintainability and automation.
If you have suggestions or ideas just let me know by creating an issue :)

About this repository

Technologies used:
Typescript Express Jest MongoDB
Deploy:
Docker Heroku
License:
GitHub FOSSA Status
Code quality:
LGTM Alerts LGTM Grade CPD
Automation:
CI CD ESLint security report pages-build-deployment
Repository activities:
GitHub last commit GitHub release (latest by date including pre-releases) GitHub Release Date GitHub commits since latest release (by date)

Table of contents

What this template has to offer to you

TODO

Typescript

TODO

Documentation

TODO

Clean architecture

TODO

Standards enforcement

TODO

Testing and coverage

TODO

Copy-paste detection

TODO

Vulnerabilities detection

License compatibility scanning

TODO

Continuous integration

TODO

Continuous delivery

TODO

Dependencies updates

TODO

Cool status badges

TODO

How to set up a repository using this template

  1. Remember to include all branches
    After clicking the "Use this template" button, the usual form for creating a new repository will appear.
    Remember to enable the flag labeled as "Include all branches" to also copy the gh-pages branch that contains the sources for the github-pages environment.
  2. Enable Dependabot
    Go to the "Settings" tab of the newly created repository and click "Code security and analysis" on the left; once there enable both "Dependabot alerts" and "Dependabot security updates".
  3. Add repository secrets
    TODO
  4. Update package.json and package-lock.json data
    TODO
  5. Update "automation" and "repository activity" badges
    TODO
  6. Update Lgtm badges
    TODO
  7. Update Fossa badge
    TODO

Software requirements

TODO

Launch the server and other scripts

TODO

License

This project's source code is licensed under the MIT License.
FOSSA Status

Buy me a coffee

TODO

About

A template repository for an Express server, trying to provide a good architecture, good practices, CI and CD.

License:MIT License


Languages

Language:TypeScript 99.6%Language:Dockerfile 0.4%