Table of Contents

• 🎇 Benefits
• 📗 Libraries
• 📁 Dependencies
• ⏩ Get Started
  • 🔘 Use Template
  • 🔑 Configure Github Secrets
    • 🙈 Create Github Token
    • 🍀 Code Coverage
    • 📦 Create NPM Token
    • 🔐 Create project Environment
  • 💻 Prepare to develop
  • 📍 Start Project
  • 📨 Build and Run
  • 🧪 Teste Code

🎇 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

📗 Libraries

• Node.js 16
• Typescript
• Eslint
• ODG-Linter-JS
• EditorConfig
• ReviewDog

📁 Dependencies

• Node.js 16 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

• https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

🍀 Code Coverage

Add Code Coverage support in your project

1. Install CodeCov in your account https://github.com/apps/codecov
2. Enter In https://app.codecov.io/gh/+ and search your repository
3. Click setup repo
4. 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

• https://docs.npmjs.com/creating-and-viewing-access-tokens

🔐 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:
  • create IS_PACKAGE = true
  • create NPM_TOKEN = npm_szxw......
  • create CODECOV_TOKEN = 00000000-0000-0000-0000-000000000000

💻 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 and yarn start again

yarn build && yarn start
# or
yarn dev

🧪 Teste Code

To Test execute this command

yarn test
# or
yarn test:watch