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 performance Inversion of control
• 🚨 Code Quality
• 🎇 Use Interface
• 🧪 Teste with 100% coverage

📗 Libraries

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

📁 Dependencies

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

⏩ Get Started

🚩 You can use https://github.com/Carcraftz/TLS-Fingerprint-API and its forks to have an easy TLS server

🔘 Installation

yarn add @odg/tls

💻 Usage

For simple example usage, you can use Inversify for Dependency Injection

const tlsMessage = new TlsMessage({
  tls: {
    url: "http://localhost:8082",
  }
});

await tlsMessage.request({
    url: "https://tls.browserleaks.com/json",
});

📍 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