src="https://raw.githubusercontent.com/ODGodinho/Stanley-TheTemplate/main/public/images/Stanley.jpg"
alt="Stanley Imagem" width="500"
/>



Stanley The Template For Typescript By Dragons Gamers

Template Stanley for Typescript projects and packages 📦!

!Repository size

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
!AutoReview Comment example
- 🧪 Automatic Test when opening pull-request/merge
- 📈 Automatic Code Coverage when opening pull-request/merge
!Code Coverage example
- 📦 Automatic Package and release generate on merge
- 🪝 Run Lint/Test command pre-commit execute

📗 Libraries

- Node.js 18
- Typescript
- Eslint
- ODG-Linter-JS
- EditorConfig
- ReviewDog

📁 Dependencies

- Node.js 18 or later
- Yarn Optional/Recommended
- ODG TsConfig Last Version

⏩ Get Started

---

$3

Click in use this template button and clone your template project

!Use Template

$3

#### 🙈 Create Github Token

Before create new GITHUB_TOKEN in

-

#### 🍀 Code Coverage

Add Code Coverage support in your project

1. Install CodeCov in your account
2. Enter In 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

-

#### 🔐 Create project Environment

- On GitHub.com, navigate to the main page of the repository.
- Under your repository name, click ⚙️ Settings.
!Github Setting images example
- 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
- variables:
- create IS_PACKAGE = true

$3

Copy .env.example to .env and add the values according to your needs.

$3

First install dependencies with the following command

``bash
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

`bash
yarn build && yarn start


or


yarn dev
`

🧪 Teste Code

To Test execute this command

`bash
yarn test


or


yarn test:watch
``