INSTALLATION.md

Instalação

Antes de tudo, vale lembrar que se você quiser apenas acessar a plataforma para experimentá-la, você pode fazer isso através deste link.

Se deseja executar o projeto na sua máquina, você precisa, antes de tudo, instalar as seguintes ferramentas: Git, Node.js, Yarn (opcional). Caso queira alterar algum arquivo sugiro também que instale algum editor de texto, como o Visual Studio Code e o Sublime.

Após isso, clone o repositório na pasta de sua escolha utilizando o seguinte comando na linha de comando:

git clone https://github.com/marcel099/rs-nlw-02-proffy

Back-End

É necessário manter o servidor em execução através destes comandos para o correto funcionamento da plataforma. Para isso, comece instalando as dependências:

# Acesse a pasta do back-end a partir da pasta do repositório
$ cd server

# Instale as dependências de funcionamento
$ npm install

Em seguida, crie um banco de dados PostgreSQL antes de executar a aplicação. Aconselho que crie o banco de dados Postgre utilizando o software Docker, pois foi a forma utilizada na versão 2.0 do projeto.

Com o banco de dados pronto, preencha as informações de variáveis de ambiente presentes no arquivo .env.example, o que inclui as credenciais de conexão ao banco Postgres que você configurou.

Por fim, rode o seguinte comando para executar a aplicação Back-End:

$ npm run dev

Front-End Web

É necessário abrir outra linha de comando para executar estes comandos sem que a anterior seja fechada visto que as aplicações web e mobile consomem e manipulam dados da aplicação back-end.

# Acesse a pasta do front-end web a partir da pasta do repositório
cd web

# Instale as dependências
npm install

# Inicie a aplicação Vite com React
$ npm run dev

Front-End Mobile

Para executar a aplicação mobile:

# Acesse a pasta do front-end mobile a partir da pasta do repositório
cd mobile

# Instale as dependências
npm install

# Inicie a aplicação Vite com React
$ npm start

Após, você poderá acessar o aplicativo através do app Expo Go ao apontar a câmera do seu celular dentro desse app no QRCode que aparecerá na tela do terminal. Se não quiser utilizar outro dispositivo, o acesso pode ser feito utilizando emuladores Android ou iOS.