Boilerplate React com Typescript

Arquivo README.md e estrutura do código baseados no repositório open source Take Note

Features

• Tela de Login com token JWT e criptografia bcrypt da senha;
• Tela Home com lista de usuários da API Random User
• Tela Dogs com imagem de um Dog aleatório da API Random Dog
• Tela Cats com imagem de um gato associado a um status HTTP (API HTTP Cat)
• Tela Clients com um CRUD de clientes
• Banco de dados Mongo DB (apenas local)]

Instruções de uso

• Rode ctrl + shift + f e pesquise por todos os lugares que usam o nome "Boilerplate" e os renomeie para o nome da empresa / logo da aplicação
• troque as imagens usadas na aplcaçao e no favicon do browser pelas logos da aplicação
• https://onlinepngtools.com/resize-png para criar os icones na forma correta (192 e 512)
• https://convertio.co/pt/png-ico/ para converter para arquivo .ico
• No mongo local, crie um novo banco com o nome correto, copie as coisas do boilerplate para ele (evite excluir o banco do boilerplate local)

Instalação (Windows)

Siga os passos abaixo para compilar a aplicação localmente. Assumindo que já possua as seguintes versões instaladas em sua máquina:

• npm: v 6.14.13
• node: v 14.17.1

1. Frontend

Instale o yarn e em seguida as dependencias

cd frontend
npm i -g yarn
yarn
yarn start

Agora a aplicação do frontend já deve estar rodando em seu navegador padrão!

2. Backend

Comece instalando o mongoDB localmente em sua máquina seguindo o esse link do SO,

Com o mongo rodando em sua máquina, crie um arquivo .env dentro da basta ./backend e defina as seguintes variáveis de ambiente:

• DB_CONNECTION_STRING
• JWT_SECRET
• TOKEN_EXPIRE_TIME
• PORT

No MongoCompass, crie as collections users e clients no banco a que o servidor está conectado. Crie o usuário default na collection user com as credenciais necessárias de username e senha.

Feito isso, instale as dependências do servidor com

cd backend
yarn
yarn dev

Usamos nodemon para compilar o servidor durante o desenvolvimento.

Com o front e back rodando, conectado ao mongo rodando local, já deve estar tudo funcionando! (espero)

Autor

• Raphael Leivas