https://github.com/mk-nascimento/fastapi-bookstore-api
Esta é uma aplicação RESTful API construída com FastAPI, SQLAlchemy, PostgreSQL e Poetry como gerenciador de dependências.
https://github.com/mk-nascimento/fastapi-bookstore-api
alembic fastapi fastapi-sqlalchemy postgresql python python-3 restful-api
Last synced: 3 months ago
JSON representation
Esta é uma aplicação RESTful API construída com FastAPI, SQLAlchemy, PostgreSQL e Poetry como gerenciador de dependências.
- Host: GitHub
- URL: https://github.com/mk-nascimento/fastapi-bookstore-api
- Owner: mk-nascimento
- License: apache-2.0
- Created: 2024-05-31T18:22:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-19T13:13:16.000Z (12 months ago)
- Last Synced: 2025-01-22T03:25:08.894Z (5 months ago)
- Topics: alembic, fastapi, fastapi-sqlalchemy, postgresql, python, python-3, restful-api
- Language: Python
- Homepage: https://bookstore.api.mk-nascimento.online/docs
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FastAPI Bookstore API
Esta é uma aplicação RESTful API construída com FastAPI, SQLAlchemy, PostgreSQL e gerenciada pelo Poetry.
## Pré-requisitos
Certifique-se de ter os seguintes itens instalados em sua máquina:
- [](https://www.postgresql.org/download/)
- [](https://www.python.org/downloads/release/python-3110/)
- [](https://python-poetry.org/docs/#installation)## Configuração do Ambiente
1. Clone o repositório:
```bash
git clone https://github.com/mk-nascimento/fastapi-bookstore-api.git
cd fastapi-bookstore-api
```2. Instale as dependências:
- Poetry
> Antes de prosseguir com a instalação, é recomendado verificar a versão do Python e Poetry recomendada no topo deste arquivo. Certifique-se de ter a versão correta instalada em seu sistema antes de continuar.
```bash
poetry install
```- Ou, se você preferir usar pip:
> Antes de prosseguir com a instalação, é recomendado verificar a versão do Python recomendada no topo deste arquivo. Certifique-se de ter a versão correta instalada em seu sistema antes de continuar.
```bash
pip install -r requirements.txt
```3. Crie e configure o banco de dados PostgreSQL. Em seguida, crie um arquivo `.env` na raiz do projeto baseado no arquivo [.env.example](.env.example):
- Copie o conteúdo de [.env.example](.env.example) para um novo arquivo `.env` e atualize as credenciais conforme necessário:
```bash
cp .env.example .env
```4. Ative o ambiente virtual:
- Poetry:
```bash
poetry shell
```- Ou, caso utilize um ambiente virtual criado com `venv`:
```bash
# Crie um ambiente virtual com o nome desejado, substituindo "" por um nome escolhido:
python -m venv
```- Sistemas Unix-like "Linux/Mac":
```bash
source /bin/activate # Linux/Mac
```- Sistemas Windows:
```bash
\Scripts\activate # Windows
```5. Execute as migrações do banco de dados:
```bash
alembic upgrade head
```## Rodando a Aplicação
Execute a aplicação com o comando:
```bash
uvicorn bookstore.main:app --reload
```A API estará disponível em http://127.0.0.1:8000.
## Licença
Este projeto está licenciado sob a licença Apache 2.0 - veja o arquivo [LICENSE](LICENSE) para detalhes.