A personal boilerplate that I use in my Node APIs with Typescript.
There are a few options for using this template:
- Clone the repository:
git clone https://github.com/gcleiton/ts-api-boilerplate.git
- Create new repository: click Use this template button at the top of this repository
- Github CLI:
gh repo create myrepo --template https://github.com/gcleiton/ts-api-boilerplate.git
start
: runs the application in the production modebuild
: builds the application version for productionbuild:watch
: builds the application in the interactive watch modedebug
: observes changes with nodemonup
: runs the application with dockerdown
: stops the application with dockerlint
: runs linter on projecttest
: launches the test runnertest:unit
: launches the test runner only in unit tests (.spec)test:integration
: launches the test runner only in integration tests (.test)test:staged
: launches the test runner only files on staged area (used in pre-commit hook integration)test:ci
: launches the test runner with coverage
- Typescript
- Express
- Jest
- Nodemon
- Rimraf
- ESLint
- Prettier
- Husky
- Lint Staged
- Git Commit Message Linter
- EditorConfig
- Git
- Github Workflows
- Yarn
I would like to thank the knowledge passed on by the instructor Rodrigo Manguinho where through them I was able to create this boilerplate that I use in my typescript api projects.