https://github.com/ledsouza/api-escola
API REST para gerenciamento de dados de uma escola fictícia, desenvolvida com Django REST Framework como parte do curso da Alura.
https://github.com/ledsouza/api-escola
django django-cors-headers django-rest-framework python
Last synced: 3 months ago
JSON representation
API REST para gerenciamento de dados de uma escola fictícia, desenvolvida com Django REST Framework como parte do curso da Alura.
- Host: GitHub
- URL: https://github.com/ledsouza/api-escola
- Owner: ledsouza
- Created: 2024-06-06T13:28:24.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T13:41:53.000Z (12 months ago)
- Last Synced: 2025-01-14T05:20:56.958Z (4 months ago)
- Topics: django, django-cors-headers, django-rest-framework, python
- Language: Python
- Homepage:
- Size: 191 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Django Escola API
API REST para gerenciamento de dados de uma escola fictícia, desenvolvida com Django REST Framework como parte do curso da Alura.
## Descrição
Este projeto implementa uma API completa para interagir com dados de uma escola. A API fornece acesso a informações sobre alunos, cursos e matrículas, e oferece diferentes níveis de permissão para diferentes tipos de usuários.
## Tecnologias Utilizadas
- Python 3
- Django
- Django REST Framework
- Django Cors Headers (para configurar CORS)
## Funcionalidades Detalhadas
**Versões da API:**
- **v1:** Versão inicial da API.
- **v2:** Inclui um campo adicional para o número de celular do aluno.
**Recursos:**
- **Alunos:** Consultar, adicionar, editar e remover informações de alunos.
- **Cursos:** Consultar, adicionar, editar e remover informações de cursos.
- **Matrículas:** Consultar, adicionar, editar e remover matrículas de alunos em cursos.
**Segurança:**
- **Autenticação:** A API requer autenticação para todas as requisições.
- **Autorização:** Diferentes tipos de usuários possuem permissões específicas para acessar e modificar dados.
- **Limite de Requisições:** Implementado um limite de requisições diárias por usuário para prevenir abusos.
**Funcionalidades Adicionais:**
- **CORS:** Configuração de CORS para permitir o consumo da API por um aplicativo React.
## Como Usar
1. Clone este repositório: `git clone https://github.com/seu_usuario/django-school-api.git`
2. Crie um ambiente virtual `poetry install`
3. Ative o ambiente virtual: `poetry shell`
4. Aplique as migrações: `python manage.py migrate`
5. Inicie o servidor de desenvolvimento: `python manage.py runserver`
6. Acesse a pasta do app React e instale as dependências: `npm install`
7. Atualize as dependências do npm com o seguinte comando: `npm update`
8. Inicie o servidor do frontend: `npm start`