@odg/test

Stanley The Template For Typescript By Dragons Gamers.

Template Stanley for Typescript projects and packages 📦

Table of Contents

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

🎇 Benefits

• 🚀 Speed start new project or package using typescript
• 🚨 Over 300 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

📗 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 Token

🙈 Create Github Token

Before create new GITHUB_TOKEN in

• https://docs.github.com/en/enterprise-server@3.4/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

🔐 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.

💻 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