Maroon

Front end para a Plataforma Digital PEA Pescarte

---

Setup

GitHub Packages

Antes de subir o ambiente com Docker, é necessário autenticar-se no GitHub Packages. Crie um token acessando as configurações do seu perfil GitHub > Developer Settings > Personal Access Tokens. Para saber quais são as permissões necessárias para o token, leia a documentação sobre o GitHub Packages.

Após criar o token, já é possível fazer a autenticação no GitHub Packages:

echo "<personal_token>" | docker login ghcr.io -u USERNAME --password-stdin

Requerimentos mínimos

requirement	release
nodejs	16.5.0+
rescript	9.1.4+
yarn	1.22.5+

---

Ambiente de Desenvolvimento

Primeira vez rodando

É necessário construir as imagens do Docker ou baixá-las via Github Packages.

Para construí-las localmente, execute (isso levará um tempo considerável):

docker-compose build

Caso queira baixar as imagena já existentes, execute:

docker pull ghcr.io/cciuenf/pescarte_maroon_rescript:latest

para baixar a imagem que executa o compilador do ReScript, e execute:

docker pull ghcr.io/cciuenf/pescarte_maroon_next:latest

que baixará a imagem que levanta o servidor web em modo de desenvolvimento.

Sempre que for rodar o projeto

Para iniciar o fluxo de desenvolvimento, é preciso iniciar o compilador do ReScript em modo de escuta e levantar o servidor web em modo de desenvolvimento. Para isso, execute:

docker-compose up

Lembre-se que para esse comando funcionar, é necessário ter as imagens do Docker contruídas ou baixadas.

Para atualizar ou instalar novas dependências

Se a dependência for apenas do contexto do NodeJS / NextJS:

docker-compose run --rm next yarn

Caso seja uma dependência do ReScript, execute o comando anterior e o seguinte:

docker-compose run --rm rescript yarn

Portas expostas no sistema do host

Para acessar o servidor de desenvolvimento, acesse o localhost.

container	port
maroon	3000

Materiais, Tutoriais, Relatórios e extras

Todo o material do projeto (tanto backend ou frontend) pode ser encontrado no repositório documentos_pea_pescarte, que abriga diversos artigos.