richardsouzza / squad-24

Repositório para desenvolvimento backend do squad24 de residenciaII 01/2024

Squad 24

Deploy da aplicação

https://squad24.onrender.com

Instalação e Execução

1. Instale o Git

2. Clone o repositório em sua máquina local:
   git clone https://github.com/Quantum-educ/residenciaII-01.2024-squad24

3. Acesse a pasta do projeto: cd residenciaII-01.2024-squad24

4. Instale o Python

5. Crie um ambiente virtual Python: python -m venv venv

   obs: o comando "python" pode mudar a depender de como foi instalado, se "python" nao funcionar tente "py" ou "python3".

6. Ative o ambiente virtual:

   Sistema operacional	Comando
   Linux	source venv/bin/activate
   Windows	venv/Scripts/activate

7. Instale as dependências do projeto:
   pip install -r requirements.txt

8. Realize as migrações do banco de dados:
   python escola_ez/manage.py makemigrations home --empty
python escola_ez/manage.py makemigrations users --empty
python escola_ez/manage.py makemigrations
python escola_ez/manage.py migrate

9. Crie um super usuário:
   python escola_ez/manage.py createsuperuser

   obs: você será solicitado a inserir um nome de usuário, email e senha.

10. Execute o aplicativo:
    python escola_ez/manage.py runserver

11. Acesse o localhost do aplicativo: http://localhost:8000

Documentação Inicial

Este é um trecho do nosso diagrama de classes UML.

ainda incompleto, onde a tabela de "perfil" será preenchida

Aqui está um exemplo de model:

from django.db import models


class ModelDeExemplo(models.Model):
  """
 Documentação do Model...
  
  
 Atributos
 ----------
 Guarda um valor para um campo:: 

   campo_teste: tipo
  

 Métodos
 -------
 Aqui uma breve descrição do metodo::

   metodo(parametros): str
  ...
  """
  
  campo_teste = models.TipoDoCampo(
   ...
  )
  
  # Outros campos...
  
 
  def metodo(argumentos: tipo) -> tipo:
    ...
   

  # Outros métodos...