Skip to content

Execução

Jump to bottom
Orivaldo Santana Jr edited this page Apr 27, 2023 · 5 revisions

Esta página contém informações sobre como o código pode ser executados nos ambientes de testes e de produção.

Ambiente de teste local

Esta seção apresenta o passo a passo de como o desenvolvedor pode executar o código em sua máquina.

Pré-requisitos

  • Nodejs

    Para executar o projeto em sua máquina (front e backend), você precisa ter configurado um ambiente que rode o Nodejs para execução do nosso código javascript.

    Caso você ainda não tenha esse ambiente configurado, a própria documentação do node pode te ajudar: https://nodejs.dev/pt/learn/how-to- install-nodejs/

  • Yarn

    Utilizamos o yarn para gerenciamento de dependências do projeto. Você consegue rodar o projeto se já tiver o npm instalado, mas para seguir o padrão, o recomendado é ter configurado o yarn.

    Caso você não tenha o yarn configurado em sua máquina, a documentação pode te ajudar: https://classic.yarnpkg.com/en/docs/install

  • Git

    Utilizamos o git para o versionamento de código do projeto. Se você pretende realizar contribuições, vai precisar ter o git configurado em seu ambiente.

    Caso ainda não tenha o git configurado, a documentação pode te ajudar: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

  • Mongodb (obrigatório apenas pro backend)

    Nós utilizamos o Mongodb como banco de dados do projeto backend. O ambiente onde você precisa configurar o mongo é de sua preferência, pois o backend só vai precisar de uma url válida para acessar o banco na inicialização.

    Aqui estão algumas opções que você pode aderir:

Como executar o Backend

Nosso backend é escrito em typescript e nós também utilizamos um framework chamado Nestjs.

Você deve configurar as variáveis de ambiente em um arquivo '.env' na raiz do projeto, um exemplo resumido do conteúdo deste arquivo é o seguinte:

NODE_ENV="development"
DATABASE_HOST="mongodb+srv://XXXXXXXXX"

Atualmente, para conseguir executar o backend localmente, você deve seguir estes passos:

⚠️ OBS: Execute esses comandos na raiz do projeto do backend ⚠️

  • Instale as dependências do projeto:

    yarn install

  • Configure as credenciais do banco de dados: Acesse o arquivo src/app.module.ts e altere as credenciais no método MongooseModule.forRoot de acordo com o seu ambiente mongodb.

  • Execute o projeto:

    yarn start:dev

Se tudo ocorrer bem, você verá logs de sucesso como:

[Nest] 15009  - dd/mm/yyyy hh:mm:ss  LOG [NestApplication] Nest application successfully started +4ms

Como executar o Frontend

No frontend utilizamos React e Nextjs.

Atualmente, para executar esse projeto localmente você só precisa seguir estes passos:

⚠️ OBS: execute esses comandos na raiz do projeto do frontend ⚠️

  • Instale as dependências do projeto: 
    yarn install
  • Execute o projeto 
    yarn dev

Se tudo ocorrer bem, você verá logs de sucesso como:

ready - started server on 0.0.0.0:3000, url: http://localhost:3000
event - compiled client and server successfully in 1308 ms (779 modules)

Agora basta acessar http://localhost:3000 para visualizar o projeto no browser.

Clone this wiki locally