Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

Commit

Permalink
docs(installation): add instructions on README
Browse files Browse the repository at this point in the history
  • Loading branch information
thegm445 committed Oct 10, 2023
1 parent fccd6e8 commit ee6079d
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,4 @@ Explorar

reunioes/intro
scrum/intro
instalation/intro
29 changes: 29 additions & 0 deletions docs/source/instalation/guia/guia01.rst
Original file line number Diff line number Diff line change
@@ -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``
20 changes: 20 additions & 0 deletions docs/source/instalation/intro.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit ee6079d

Please sign in to comment.