Preparando o ambiente de desenvolvimento

Há duas maneiras de subir o projeto em modo de desenvolvimento, utilizando python ou docker

O primeiro passo é clonar o repositório do projeto, executando o comando:

git clone git@bitbucket.org:viasoftnela/reports.git

Usando Docker:

1. Instale o Docker

   Para instalar o Docker, siga as instruções da documentação oficial: https://docs.docker.com/get-started/

   Caso utilize MacOs, siga as instruções da documentação oficial: https://docs.docker.com/desktop/install/mac-install/

2. Instale o Docker Compose

   Para instalar o Docker Compose no Ubuntu 22.04, siga as instruções do artigo: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-22-04

   Caso utilize MacOs, o docker desktop já instala por padrão o docker compose

3. Inicie a aplicação

   Acesse a pasta src do projeto

   Para usuários de linux você pode usar o seguinte comando:

   docker-compose up -d

   Para usuários do mac os

   docker compose up -d

4. Acesse a aplicação

   Agora que você criou um container Docker, você pode acessar a aplicação através do seu navegador. Para fazer isso, abra um navegador e acesse o endereço http://localhost:8000/

   Onde você vai ter o mesmo resultado desta documentação, porém, localmente

Usando Python

1. Instale o python

   Para instalar o Python, siga as instruções da documentação oficial: https://python.org.br/instalacao-linux/

   Caso utilize MacOs ele já vem instalado por padrão.

2. Criar um environment para o projeto

   Um ambiente virtual no Python é uma maneira de isolar as dependências de um projeto do ambiente Python global. Isso é útil para evitar conflitos de dependências entre projetos diferentes e para manter o ambiente Python global limpo e organizado.

   Acesse a pasta onde foi clonado o projeto para criar o ambiente virtual no Python, você pode usar o seguinte comando:

   python3 -m venv venv

   Este comando irá criar um diretório chamado `venv` na pasta atual. Este diretório contém um interpretador Python, um gerenciador de pacotes e um conjunto de bibliotecas.

   Para ativar um ambiente virtual, você pode usar o seguinte comando:

   source venv/bin/activate

   Este comando irá definir a variável de ambiente VIRTUAL_ENV para apontar para o diretório do ambiente virtual. Agora para instalar as dependências de um projeto em um ambiente virtual, acesse a pasta src e você pode usar o seguinte comando:

   pip install -r requirements.txt

   Este comando irá instalar todas as dependências listadas no arquivo requirements.txt.

   Aqui estão algumas dicas para usar ambientes virtuais no Python:

   1. Sempre crie um ambiente virtual para cada projeto. Isso ajudará a evitar conflitos de dependências.
   2. Ative o ambiente virtual antes de começar a desenvolver o seu projeto. Isso garantirá que o Python esteja usando as bibliotecas corretas.
   3. Desative o ambiente virtual quando terminar de desenvolver o seu projeto. Isso ajudará a manter o ambiente Python global limpo e organizado.

3. Iniciando a aplicação

   Para iniciar a aplicação, esperando que esteja dentro da pasta src, execute esse comando:

   python3 manage.py runserver

   Você pode acessar a aplicação através do seu navegador. Para fazer isso, abra um navegador e acesse o endereço http://localhost:8000/

Instalando dependências adicionais

Neste projeto utilizamos a lib Tailwind para estilizar os relatórios, então deve ser instalado as dependências, estando na pasta "root" utilize o comando:

npm install

ou

yarn install