| ... | ... | @@ -15,11 +15,11 @@ Esta seção apresentará todas as configurações para executar o projeto. |
|
|
|
- [Clonando os Repositórios](#clonando-os-repositórios)
|
|
|
|
- [Backend](#backend)
|
|
|
|
- [Configurando a Máquina](#configurando-a-máquina)
|
|
|
|
- [Compilando](#compilando)
|
|
|
|
- [Preparando Para Executar](#Preparando Para Executar)
|
|
|
|
- [Executando](#executando)
|
|
|
|
- [Frontend](#frontend)
|
|
|
|
- [Configurando a Máquina](#configurando-a-máquina-1)
|
|
|
|
- [Compilando](#compilando-1)
|
|
|
|
- [Preparando Para Executar](#Preparando Para Executar-1)
|
|
|
|
- [Executando](#executando-1)
|
|
|
|
|
|
|
|
## Configurações Gerais
|
| ... | ... | @@ -56,26 +56,47 @@ Para clonar os repositórios, siga os seguintes passos: |
|
|
|
|
|
|
|
### Configurando a Máquina
|
|
|
|
|
|
|
|
TBD
|
|
|
|
O Node.js, abordado na sessão [Instalando o Node](#instalando-o-node), é a única dependência necessária para executar a aplicação do backend.
|
|
|
|
|
|
|
|
### Compilando
|
|
|
|
### Preparando Para Executar
|
|
|
|
|
|
|
|
TBD
|
|
|
|
Para poder executar a aplicação, são necessários apenas 4 passos:
|
|
|
|
1. Abrir o VSCode na pasta do backend;
|
|
|
|
2. Abrir um terminal no VSCode, na pasta do backend;
|
|
|
|
3. Rodar o comando "npm install" no terminal;
|
|
|
|
4. Possuir o .env preenchendo os seguintes atributos (consultar algum AGES III ou IV da equipe para conseguir os dados):
|
|
|
|
AWS_ACCESS_KEY_ID=
|
|
|
|
AWS_SECRET_ACCESS_KEY=
|
|
|
|
AWS_DEFAULT_REGION=
|
|
|
|
ENVIRONMENT=
|
|
|
|
LOCAL_PRIVATE_KEY=
|
|
|
|
PRODUCTION_PRIVATE_KEY=
|
|
|
|
|
|
|
|
### Executando
|
|
|
|
|
|
|
|
TBD
|
|
|
|
Para executar, rode o comando "npm run dev" e aguarde a aparição de "Server is running" no seu terminal. Após "Server is running" aparecer, abra o seu browser e visite a URL http://localhost:3333/api-docs/, para visualizar a documentação da api. Caso ocorra algum erro relacionado a "token inválido", vá para o arquivo "app.ts" e comente a linha "this.server.use(verifyIdToken)" TEMPORARIAMENTE (descomentar depois de realizar as tarefas que você precisava fazer sem o frontend ativo).
|
|
|
|
|
|
|
|
## Frontend
|
|
|
|
|
|
|
|
### Configurando a Máquina
|
|
|
|
|
|
|
|
TBD
|
|
|
|
O Node.js, abordado na sessão [Instalando o Node](#instalando-o-node), é a única dependência necessária para executar a aplicação do frontend.
|
|
|
|
|
|
|
|
### Compilando
|
|
|
|
### Preparando Para Executar
|
|
|
|
|
|
|
|
TBD
|
|
|
|
Para poder executar a aplicação, são necessários apenas 4 passos:
|
|
|
|
1. Abrir o VSCode na pasta do frontend;
|
|
|
|
2. Abrir um terminal no VSCode, na pasta do frontend;
|
|
|
|
3. Rodar o comando "npm install" no terminal;
|
|
|
|
4. Possuir o .env preenchendo os seguintes atributos (consultar algum AGES III ou IV da equipe para conseguir os dados):
|
|
|
|
REACT_APP_API_KEY=
|
|
|
|
REACT_APP_AUTH_DOMAIN=
|
|
|
|
REACT_APP_PROJECT_ID=
|
|
|
|
REACT_APP_STORAGE_BUCKET=
|
|
|
|
REACT_APP_MESSAGING_SENDER_ID=
|
|
|
|
REACT_APP_APP_ID=
|
|
|
|
REACT_APP_API_URL=
|
|
|
|
|
|
|
|
### Executando
|
|
|
|
|
|
|
|
TBD |
|
|
|
**ATENÇÃO: É necessário executar o backend antes de executar o frontend, caso contrário, a aplicação não conseguirá funcionar adequadamente.**<br/>
|
|
|
|
Para executar, apenas rode o comando "npm start" e a aplicação abrirá no seu browser padrão. |
