📚 API BR – Catalog

---

📌 Purpose

API BR – Catalog is the central hub for the API BR project. It provides a clean, user-friendly interface listing the available public services in the ecosystem. Services are grouped by category and link directly to their respective repositories.

🔗 Available Services

• Developer Vacancies
  REST API to access developer job vacancies from GitHub repositories.
  Web UI built with React.

• Sports Agenda
  REST API that provides football (soccer) match schedules.
  Web UI built with React.

---

🛠️ Tech Stack

This project is built with the following technologies:

• Vite – Lightning-fast build tool for modern frontends
• React – Component-based JavaScript library for building UIs
• SWC – Super-fast JS/TS compiler used by Vite
• TypeScript – Type-safe JavaScript for scalable and reliable code

---

🚀 Getting Started

🔧 Installation

To set up the project locally:

1. Clone the repository:

   git clone https://github.com/apibr/catalog.git

2. Navigate into the project folder:

   cd catalog

3. Install dependencies:

   npm install

---

🏗️ Build

To create a production-ready build:

npm run build

This will generate an optimized bundle in the dist/ folder.

---

🧪 Testing

This project uses Vitest for unit testing.
Use the following commands:

• Run all tests:

  npm run test

• Run tests with coverage:

  npm run test:coverage

Vitest will output test results and code coverage directly in the terminal.

---

🔢 Versioning

This project follows Semantic Versioning (SemVer) and uses GitVersion v6 for automated version calculation.

Version Rules

• Patch – Backward-compatible bug fixes
• Minor – Backward-compatible features
• Major – Breaking or incompatible changes

To calculate the current version, run:

gitversion

This will output the version based on your Git history and tagging strategy.

---

📄 License

This project is licensed under the MIT License.
See the LICENSE file for full details.