Neste guia iremos configurar o ambiente de desenvolvimento, clonando o projeto e instalando suas dependências, além de mostrar como executá-lo. Ainda neste guia é possível encontrar uma breve explicação da estrutura das pastas adotada para a construção em equipe desse projeto.
🖥️ Para acessar o protótipo, acesse: https://polaris-fatec.netlify.app/
- 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...
Com todas as ferramentas necessárias devidamente instaladas, 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/web.git
# Acesse a pasta do projeto
$ cd web-main
# Instale as dependências do projeto (são listadas no arquivo package.json)
$ npm install
# ou
$ yarn
# Execute o projeto
$ npm start
# ou
$ yarn startAgora o servidor deste projeto está ativo. É só acessar pelo localhost na porta 3333: [https://localhost:3333]!
| Pasta | Definição |
|---|---|
| 📂 node_modules/ | Armazena as bibliotecas (dependências) usadas pelo projeto |
| 📂 public/ | Pasta pública do projeto acessível ao público geral por meio de um servidor web |
| 📂 src/assets | Pasta de arquivos visuais (imagens, estilização (css), componentes, fontes, lottieJSONs, scss...) |
| 📂 src/components | Código fonte dos componentes do projeto (botões, rodapés, cabeçalhos, barra de navegação..) |
| 📂 src/pages | Código fonte das páginas do projeto |
| 📂 src/services | Arquivos de serviços externos utilizados no projeto como a nossa API |
| 📄 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: