- ๐ Speed start new project or package using typescript
- ๐จ Over 800 rules for pattern, possible errors and errors in Linter
- ๐ Code quality guaranteed
- ๐ข AutoReview when opening a pull-request/merge
- ๐งช Automatic Test when opening pull-request/merge
- ๐ Automatic Code Coverage when opening pull-request/merge
- ๐ฆ Automatic Package and release generate on merge
- Node.js 16 or later
- Yarn Optional/Recommended
- ODG TsConfig Last Version
Click in use this template button and clone your template project
Before create new GITHUB_TOKEN in
Add Code Coverage support in your project
- Install CodeCov in your account https://github.com/apps/codecov
- Enter In https://app.codecov.io/gh/+ and search your repository
- Click
setup repo
- Copy CODECOV_TOKEN and create a secret called CODECOV_TOKEN
if you want to generate packages create a secret called IS_PACKAGE = true AND create new NPM_TOKEN in
- On GitHub.com, navigate to the main page of the repository.
- Under your repository name, click
โ๏ธ Settings
. - In the "Security" section of the sidebar, select
โณ๏ธ Secrets
, then click Actions. - Click New repository secret.
- Type a name with: GH_TOKEN
- Enter with your access secret token
ghp_Dsfde....
- Click Add secret.
- If you are going to publish package:
- create IS_PACKAGE =
true
- create NPM_TOKEN =
npm_szxw......
- create CODECOV_TOKEN =
00000000-0000-0000-0000-000000000000
- create IS_PACKAGE =
Copy .env.example
to .env
and add the values according to your needs.
First install dependencies with the following command
yarn install
# or
npm install
To build the project, you can use the following command
if you change files, you need to run
yarn build
andyarn start
again
yarn build && yarn start
# or
yarn dev
To Test execute this command
yarn test
# or
yarn test:watch