Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
henriquesebastiao committed Aug 24, 2024
1 parent afb3c3e commit 9a2e9a1
Showing 1 changed file with 7 additions and 17 deletions.
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,19 @@
## API - Projeto de Modernização do Manejo
[![CI](https://github.com/henriquesebastiao/modernizacao-manejo-api/actions/workflows/ci.yml/badge.svg)](https://github.com/henriquesebastiao/modernizacao-manejo-api/actions/workflows/ci.yml)

[Deploy to Render](https://manejo-api.onrender.com)
# API - Projeto de Modernização do Manejo

[![CI](https://github.com/henriquesebastiao/modernizacao-manejo-api/actions/workflows/ci.yml/badge.svg)](https://github.com/henriquesebastiao/modernizacao-manejo-api/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/henriquesebastiao/modernizacao-manejo-api/graph/badge.svg?token=YXGE5R26YM)](https://codecov.io/gh/henriquesebastiao/modernizacao-manejo-api)
[![fastapi](https://img.shields.io/badge/FastAPI-009688?style=flat&logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com/)
[![postgresql](https://img.shields.io/badge/PostgreSQL-4169E1?style=flat&logo=postgresql&logoColor=white)](https://www.postgresql.org/)

API para o backend do projeto de modernização do manejo desenvolvida com FastAPI.

Esta API, construída com FastAPI, é a espinha dorsal de um projeto voltado para o setor agropecuário. Nosso objetivo é viabilizar uma gestão de informações sobre o gado e seu desempenho, auxiliando os produtores rurais a tomar decisões mais assertivas e estratégicas.
Sobre o Projeto

A API visa proporcionar uma solução abrangente para o controle eficiente de informações relacionadas ao gado. Através dela, oferecemos funcionalidades robustas para realizar operações de CRUD no banco de dados, abrangendo desde o registro inicial até as análises avançadas de desempenho.
Principais Recursos

## Principais Recursos

CRUD Completo: Gerencie suas informações sobre o gado com facilidade, desde a adição de novos registros até a atualização e exclusão de dados existentes.

Análises de Desempenho: Utilize recursos avançados para avaliar o desempenho do gado, possibilitando a tomada de decisões mais estratégicas no manejo.

### Execução local:

```bash
git clone https://github.com/henriquesebastiao/modernizacao-manejo-api.git
cd modernizacao-manejo-api
poetry install && poetry shell
alembic upgrade head # Aplica as migrações
uvicorn app.main:app --reload
```

Abra o navegador em [http://localhost:8000/docs](http://localhost:8000/docs) para acessar a documentação da API.

0 comments on commit 9a2e9a1

Please sign in to comment.