1.0.1 โข Published 7 months ago
@odg/captcha v1.0.1
Table of Contents
๐ Benefits
- ๐ 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
- ๐ช Run Lint/Test command pre-commit execute
๐ Libraries
๐ Dependencies
- Node.js 18 or later
- Yarn Optional/Recommended
- ODG TsConfig Last Version
โฉ Get Started
๐ Use Template
Click in use this template button and clone your template project
๐ Configure Github Secrets
๐ Create Github Token
Before create new GITHUB_TOKEN in
๐ Code Coverage
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
๐ฆ Create NPM Token
if you want to generate packages create a secret called IS_PACKAGE = true AND create new NPM_TOKEN in
๐ Create project Environment
- 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:
- secrets:
- create NPM_TOKEN =
npm_szxw......
- create CODECOV_TOKEN =
00000000-0000-0000-0000-000000000000
- create NPM_TOKEN =
- variables:
- create IS_PACKAGE =
true
- create IS_PACKAGE =
- secrets:
๐ป Prepare To Develop
Copy .env.example
to .env
and add the values according to your needs.
๐ Start Project
First install dependencies with the following command
yarn install
# or
npm install
๐จ Build and Run
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
๐งช Teste Code
To Test execute this command
yarn test
# or
yarn test:watch