Documentação do negócio

Documentação técnica

\mathbb{INSTALAÇÕES \space NECESSÁRIAS}

\mathbb{FRONTEND}

Como executar para ambiente de desenvolvimento

1. Instale o Node.js, versão >= 18.
2. Instale o Yarn com o comando npm install -g yarn.
3. Instale as dependências do projeto com o comando yarn install. 3.1. Para isso, é necessário estar com um terminal aberto na pasta raiz do projeto.
4. Execute o comando yarn dev para iniciar o servidor de desenvolvimento. 4.1. Depois, acesse o endereço http://localhost:3000 no seu navegador.
5. Para mais comandos, veja o arquivo package.json em 'scripts'.

\mathbb{BACKEND}

• Passos:

1. Instale o Python, versão >= 3.9
2. Instale o Docker, em sua versão mais recente
3. Instale o gerenciador de dependências Poetry na versão 1.4.1:

$ pip install poetry==1.4.1

1. Configure o virtualenv:

$ poetry config virtualenvs.in-project true

1. Instale as dependências:

$ poetry install

1. Agora o backend pode ser executado:

poetry run uvicorn app.main:app --reload

\mathbb{DATABASE}

1. Instale o Docker, em sua versão mais recente
2. O banco de dados pode ser executado com o comando:

docker compose up mongodb

\mathbb{INFRA \space AS \space CODE}

• Vai ser necessário verificar em 90 dias o script de permissão de uso HTTPS, a AGES não fica responsável de manter um certificado HTTPS para o projeto após a finalização dele.
• A conta AWS utilizada é de teste liberado pela AGES durante o semestre, para manter o projeto no ar será necessário manter em uma conta AWS particular da empresa.
• Todo código desenvolvido é de uso público! melhorias e manter o projeto privado somente é permitido ao cliente fora do Gitlab oficial da AGES e de seus servidores internos.