This is a (slightly) opinionated Github template for creating Typescript projects.
Simply use this repository as a template for any new repository.
See: Creating a repository from a template from the Github doc.
Once this is done, you may want to get rid of the explanation comments.
- Select this repository as the template fo your new repository;
- You won't get the history from this repository, only the files (all of them) as an
Initial commit
; - Modify the stuff you need to: README, repo settings, any tsc/eslint/jest/etc. configurations
- Please get rid of the explanation comments to clean up your new repo.
Projects created from this template will get the following for free:
- Sensible defaults for your Github repository settings ;
- Sensible defaults for:
tsc
configuration;eslint
configuration;prettier
configuration;jest
configuration withts-jest
;
- Default tests location;
- Common npm scripts
- Basic CI workflow using Github actions
- Automatic dependency upgrade PRs by Dependabot
- Uploading of code coverage report to Codecov
- Maintainability score by CodeClimate
npm install
npm run lint
npm test
npm run compile:clean
Your typescript code will then compile nicely into ./lib
, conveniently ignored by git.