Neste guia iremos configurar o ambiente de desenvolvimento, clonando o projeto e instalando suas dependências, além de como executar. Ainda neste guia é possível encontrar uma breve explicação da estrutura das pastas adotada para a construção em equipe desse projeto.
- Instalação das ferramentas: como instalar o Node, NPM ou Yarn e o Visual Studio Code (tutoriais para Windows, MacOS e Linux)
- Atualização (caso já tenha as ferramentas: se já passou pelo processo de instalação do Node, NPM e Yarn alguma vez, realize este tutorial para garantir as versões mais recentes das ferramentas (para Windows, MacOS e Linux)
- Caso surja algum problema...
No arquivo .env.example, complete as variâveis com os valores abaixo e renomeie o arquivo para .env.
EARTH_SEARCH=https://earth-search.aws.element84.com/v0
STAC_API=https://api.stacspec.org/
DEV_SEED=https://sat-api.developmentseed.org/Com todas as ferramentas necessárias devidamente instaladas (Node, Git...), baixe ou clone este repositório pelo terminal seguindo passo a passo descrito abaixo:
# Baixe este repositório ou clone pelo Git usando o comando:
$ git clone https://github.com/Equipe-Polaris-DSM-2021/api.git
# Acesse a pasta do projeto
$ cd api-main
# Instale as dependências do projeto (são listadas no arquivo package.json)
$ yarn
# Execute o projeto
$ yarn devAgora o servidor deste projeto está ativo. É só acessar pelo localhost na porta 3333: [https://localhost:3333]!
| Pasta | Definição |
|---|---|
| 📂 ** tests ** | Configuração e execução de testes com Jest (para executar: yarn jest) |
| 📂 node_modules/ | Armazena as bibliotecas (dependências) usadas pelo projeto |
| 📂 src/ app/ controllers | Arquivos com os métodos de requisição das rotas |
| 📂 src/ app/ models | Arquivos considerados moldes/classes da aplicação |
| 📂 src/ database/ migrations | Arquivos gerados pelo TypeORM |
| 📄 ormconfig.json | Arquivo de configuração do TypeORM (indica login e porta do banco de dados, esquema de pastas e etc) |
| 📄 package.json | Arquivo usado para gerenciar as dependências do projeto, scripts e versões |
As seguintes tecnologias e ferramentas estão sendo utilizadas neste projeto: