https://github.com/apibr/catalog
📖 API BR - Service catalog
https://github.com/apibr/catalog
api apibr apis catalog data free-api free-apis rest-api service service-catalog
Last synced: 26 days ago
JSON representation
📖 API BR - Service catalog
- Host: GitHub
- URL: https://github.com/apibr/catalog
- Owner: ApiBR
- License: mit
- Created: 2024-11-21T12:56:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-05-20T19:20:31.000Z (about 1 month ago)
- Last Synced: 2026-05-21T00:55:15.798Z (about 1 month ago)
- Topics: api, apibr, apis, catalog, data, free-api, free-apis, rest-api, service, service-catalog
- Language: TypeScript
- Homepage: https://apibr.com
- Size: 3.65 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📚 API BR – Catalog
[](https://vitejs.dev/)
[](https://react.dev/)
[](https://www.typescriptlang.org/)
[](https://github.com/apibr/catalog/actions)
[](LICENSE)
---
## 📌 Purpose
**API BR – Catalog** is the central hub for the [API BR](https://github.com/apibr) 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
- **Banks Directory**
REST API to access Brazilian Banks List from [](https://github.com/GuiBranco/BancosBrasileiros).
Web UI built with React.
- **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:
```bash
git clone https://github.com/apibr/catalog.git
```
2. Navigate into the project folder:
```bash
cd catalog
```
3. Install dependencies:
```bash
npm install
```
---
## 🏗️ Build
To create a production-ready build:
```bash
npm run build
```
This will generate an optimized bundle in the `dist/` folder.
---
## 🧪 Testing
This project uses [**Vitest**](https://vitest.dev/) for unit testing.
Use the following commands:
- Run all tests:
```bash
npm run test
```
- Run tests with coverage:
```bash
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**](https://gitversion.net/) 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:
```bash
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](LICENSE) file for full details.