From ee6079d7678b7ea645dd75f9d5cd4bb769828ebe Mon Sep 17 00:00:00 2001 From: thegm445 Date: Mon, 9 Oct 2023 21:14:10 -0300 Subject: [PATCH] docs(installation): add instructions on README --- docs/source/index.rst | 1 + docs/source/instalation/guia/guia01.rst | 29 +++++++++++++++++++++++++ docs/source/instalation/intro.rst | 20 +++++++++++++++++ 3 files changed, 50 insertions(+) create mode 100644 docs/source/instalation/guia/guia01.rst create mode 100644 docs/source/instalation/intro.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 2063601..2df465e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -48,3 +48,4 @@ Explorar reunioes/intro scrum/intro + instalation/intro diff --git a/docs/source/instalation/guia/guia01.rst b/docs/source/instalation/guia/guia01.rst new file mode 100644 index 0000000..ec4aad9 --- /dev/null +++ b/docs/source/instalation/guia/guia01.rst @@ -0,0 +1,29 @@ +Guia01 +====== + +:bdg-info:`HowTo` + +Resumo +------ + +Para a instalação e a operação corretas, deve se ter instalado na máquina: +- Python versão 3.11.5 +- Poetry versão 1.6.1 + +Após verificar quanto aos requisitos acima, rode estes comandos: + +- ``poetry install`` +- Se necessárias dependências de documentação, ``poetry install --with docs`` +- Para instalar Git Hooks: + .. code-block:: bash + + poetry run pre-commit install \ + --hook-type commit-msg \ + --hook-type pre-commit \ + --hook-type pre-push +- Gerar o arquivo config ``poetry run ./bin/create-env`` +- Para finalizar a instalação e conseguir visualizar a página: + + - ``docker compose build && docker compose up -d`` + - ``docker compose run django python manage.py migrate`` + - ``docker compose run django python manage.py createsuperuser`` diff --git a/docs/source/instalation/intro.rst b/docs/source/instalation/intro.rst new file mode 100644 index 0000000..fcec217 --- /dev/null +++ b/docs/source/instalation/intro.rst @@ -0,0 +1,20 @@ +Instalação do projeto +===================== + +.. rst-class:: lead + + Aqui você encontrará instruções e informações necessárias para a instalação + e execução do projeto. + +Sumário +------- + +- Guia de instalação no Linux (ambiente recomendado): Guia 01 + +Guias +----- + +.. toctree:: + :titlesonly: + + guia/guia01