placework

Respositório destinado ao cadastro e login para app PlaceWork

Índice

• Bibliotecas utilizadas
• Instalação
• Utilização
• Informações Importantes

Bibliotecas utilizadas

• Django Framework para desenvolvimento rápido para web, escrito em Python, que utiliza o padrão model-template-view
• Poetry Gerenciador de dependências e empacotador de projetos para Python
• Taskpy Ferramenta para automatizar alguns comandos e simplificar o fluxo
• Ruff Um linter, para dizer se não estamos fazendo nada de errado no código
• Blue Um formatador de código bastante amigável
• Isort Uma ferramenta para ordenar os imports em ordem alfabética
• Pytest Framework de testes para Python
• Faker Biblioteca para gerar dados fakes
• MailTrap Biblioteca para envio de e-mail para desenvolvimento
• Laravel-mix Empacotador de módulos que prepara o JavaScript, css, imagens e demais ativos para o navegador -Bootstrap Framework front-end para desenvolvimento de componentes de interface e front-end para sites e aplicações web usando HTML, CSS e JavaScript

Instalação

Pré-requisitos

Docker

Instalação

1. Clone o repositório

git clone https://github.com/candidosouza/placework.git

2. Acesse a pasta do projeto

cd placework

3. Execute o comando

docker-compose up -d --build

4. Execute o comando para entrar no container da aplicação

docker-compose exec app bash

5. Execute o comando para instalar as dependências

poetry install

6. Ativar o ambiente virtual

poetry shell

7. Rodar as migrações

python manage.py migrate

8. Rodar as fixtures

python manage.py seeds

9. Rodar o servidor

 python manage.py runserver 0.0.0.0:8000

10. Acesse o sistema em http://localhost:8000

11. Acesse o pgadmin em http://localhost:5050

12. Acesse o container do postgres

docker-compose exec db bash

Em caso de problemas com a estilização

Entrar na pasta do projeto e rodar o comando:

npm install

e após a instalação, rodar o comando:

npm run watch

Acesso ao admin

• Usuário: admin
• Senha: admin

http://localhost:8000/admin-placework/

Para envio de emails:

O sistema foi configurado usando o MailTrap, para que os emails sejam enviados, é necessário configurar as variáveis de ambiente no arquivo .env:

link: https://mailtrap.io/

váriáveis necessárias:

• EMAIL_HOST_USER
• EMAIL_HOST_PASSWORD

Informações Importantes

• Algumas informações sobre os arquivos e pastas do projeto:
  • common/ - Pasta com arquivos em comuns a todos os apps do projeto
  • setup/ - Pasta com arquivos de configuração do projeto
  • placework/ - Pasta com arquivos do app