Aplicação de uma Transportadora Ficticia (Back-end, Front-end e Mobile) utilizando Node.JS, React e React Native, um desafio proposto pela Rocketseat Education, como parte de seu bootcamp.
# Para copiar o repositório
git clone https://github.com/thalesmacena/Fastfeet.git
O back-end foi feito utilizando Express.js, ele também utiliza o padrão de arquitetura MVC com o Sequelize, integrando Postgres como banco de dados e Redis para os background jobs. Além disso o projeto utiliza o padrão de estilo do Airbnb que junto com o plugin do prettier garantem um código limpo e claro.
Pré Requisitos
Para rodar o aplicato você vai precisar ter instalado:
- Uma versão atualizada do Node.JS
- O Gerenciador de pacotes Yarn ou NPM
- Uma imagem do Postgres e do redis (é recomendável que utilize Docker para ter uma imagem desses banco de dados).
- Uma conta em um smtp (Recomendo o Mailtrap que é gratuito e para desenvolvimento)
- A extensão do VS Code Humao.Rest-Client ou um Client de API como o Insomnia
- Uma cópia deste repositório localmente
Rodando a aplicação
- Acesse a pasta do Back-end e renomeie o arquivo
.env.example
para.env
, altere as variaveis de ambiente com as credencias do passo a passo. - Utilize o seguinte comando para baixar as dependencias:
yarn
- Utilize o seguinte comando para realizar as migrations do banco de dados:
yarn sequelize db:migrate
- Utilize o seguinte comando para popular o banco de dados com o primeiro administrador:
yarn sequelize db:seed:all
- Utilize o seguinte comando para rodar o projeto:
yarn dev
- Utilize o seguinte comando para rodar as filas de background jobs:
yarn queue
- Utilize a extesão abrindo os arquivos .http da pasta
src/requests
ou utilize essas requisições como base no seu client de API
Para vizualizar a documentação da API utilize o seguinte comando:
yarn api
Esse comando ira renderizar a documentação da api em localhost:8080
O Front-end é feito em React utilizando o Framework Next.js, ele é estilizado utilizando styled-components.
Pré Requisitos
Para rodar o aplicato você vai precisar ter instalado:
- Uma versão atualizada do Node.JS
- O Gerenciador de pacotes Yarn ou NPM
- Uma cópia deste repositório localmente
Rodando a aplicação
- Acesse a pasta web, que é referente ao front-end web
- Utilize o seguinte comando para baixar as dependencias:
yarn
- Você pode rodar o programa com o seguinte comando:
yarn dev
The application will run on localhost:3000
Futuramente o front-end web da aplicação estará hospedado na vercel para ser experimentado