Esta ferramenta digital faz parte do catálogo de ferramentas do Banco Interamericano de Desenvolvimento. Você pode saber mais sobre a iniciativa do BID em code.iadb.org
- Tabela de conteúdos:
- Informações
- Descrição e contexto
- Documentação
- Documentação Externa
- Guia de instalação
- Dependências
- Como contribuir
- Estrutura do projeto gerado
- Autor(es)
- Licença
-
Dependências de Terceiros:
-
Esse projeto foi desenvolvimento para facilitar o desenvolvimento de sistemas Django trazendo diversas tecnologias embarcadas para expandir o conceito Don't Repeat Yourself (DRY). Além das tecnologias já embarcadas, temos managers para automatizar a geração de código do projeto.
Utilizamos no desenvolvimento da ferramenta o pacote mkdocs, para gerar a documentação do projeto, acesse o site do mkdocs para maiores informações.
Acesse a documentação contendo todos os detalhes do projeto em: https://agtecpalmas.github.io/AgtecCore/
- Clone este projeto
git clone https://github.com/AgtecPalmas/AgtecCore
- Crie um diretório para o seu projeto fora do Clone
mkdir <nome_do_seu_projeto>
- Acesse o diretório criado na etapa anterior
cd <nome_do_seu_projeto>
- Crie e ative um ambiente virtual python (Exemplo)
python3 -m venv venv
source venv/bin/activate
- Atualize o PIP (Recomendado)
python3 -m pip install --upgrade pip
- Instale o cookiecutter
pip install cookiecutter==2.3.0- Inicie o projeto com o Cookiecutter apontando para o Clone do Agtec Core
cookiecutter <caminho_para_o_clone>/AgtecCore
-
Siga os passos informados no terminal
-
Configure seu arquivo .env com as informações do seu banco de dados
-
Execute as migrações
python3 manage.py makemigrations
python3 manage.py migrate
- Crie um super usuário
python3 mock_superuser.py
- Execute o projeto
python3 manage.py runserver
- Caso o processo do Cookiecutter não tenha sido concluído corretamente, execute os comandos abaixo para instalar as dependências do projeto
python3 -m pip install -r requirements.txt
python3 -m pip install -r requirements-dev.txt
- Construa as aplicações iniciais
python3 manage.py build usuario --all
python3 manage.py build configuracao_core --all
Principais dependências do projeto:
# Produção
Django
Django Rest Framework
PsyCopg
Sentry
...
# Desenvolvimento
Black
Djlint
Mkdocs
Pytest
Rich
Taskipy
...
Há várias formas de contribuir com o projeto, com código, testes, documentação, etc. Acesse a documentação externa na seção Documentação Externa para saber mais sobre como contribuir com o projeto.
flowchart TD
A[ AgtecCore - Cookiecutter ]
A --> B( cookiecutter.. /AgteCore )
B --> D[ Projeto Django baseado no AgteCore]
D --> E[ Projeto Django ]
E --> F( settings.py )
E --> G( urls.py )
E --> H( wsgi.py )
E --> I( manage.py )
I --> T([ build ])
I --> U([ fastapi])
I --> v([ flutter ])
E --> J[ apps ]
J --> K[ atendimento ]
J --> M[ core ]
J --> N[ configuracao_core ]
J --> O[ contrib ]
J --> S[ usuario ]
E --> P[ base ]
E --> Q[ contrib ]
E --> R[ docs]
T --> X( forms.py )
T --> Y( models.py )
T --> Z( views.py )
T --> AA[ templates ]
subgraph " "
AA --> AB( index.html )
AA --> AC( create.html )
AA --> AD( detail.html )
AA --> AE( update.html )
AA --> AF( delete.html )
end
The MIT License (MIT)
Copyright © 2023 Agência de Tecnologia da Informação da Prefeitura de Palmas estado do Tocantins
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
