humberto-bonadiman / softeo-backend

Boas vindas ao repositório do projeto Softeo Backend!

Descrição do projeto

O desafio consistiu na criação de uma aplicação web para gerenciamento de uma lista de valores cobrados por uma odontologista. Nele é possível criar usuário, realizar login através do dentiste e a criar, atualizar dados, filtrar por data do procedimento e deletar o cliente. Este é o frontend da aplicação.
A ideia de realizar cadastro na aplicação se deve a possibilidade de outras pessoas também poderem usar no futuro.

---

Instalação do projeto localmente

Após cada um dos passos, haverá um exemplo do comando a ser digitado para fazer o que está sendo pedido.

1. Abra o terminal e crie um diretório no local de sua preferência com o comando mkdir:

  mkdir projeto-humberto

2. Entre no diretório que acabou de criar e depois clone o projeto:

  cd projeto-humberto
  git clone [e-mail]:Humberto-Bonadiman/softeo-backend.git

3. Acesse o diretório do projeto e depois utilize o comando npm i para instalar todas as dependências necessárias:

  cd softeo-backend
  npm install

4. Crie um arquivo .env e copie os dados das variáveis de ambiente do arquivo .env.example conforme os dados do seu MySQL:

  touch .env

5. Gere a migration do projeto através do comando:

  npm run migrate

6. Por último, rode o comando npm start e acesse o projeto via browser, no caminho http://localhost:3001/.

  npm start

Ou também é possível rodar a aplicação pelo comando:

  npm run nodemon

---

Variavéis de ambiente

  CLEARDB_DATABASE_URL="mysql://{userMysql}:{randompassword}@localhost:3306/dentist_db?schema=public"
  JWT_SECRET=put_secret_key_here
  DATABASE_PASSWORD=prisma
  PORT=3001

Troque em CLEARDB_DATABASE_URL {userMysql} pelo seu usuário do MySQL e em {randompassword} pela sua senha do MySQL.
Observação: remover os chaves({}) também desta linha.
Troque o valor de JWT_SECRET pelo valor que lhe trouxer mais segurança pois ele será necessário para gerar o token através do login.
E o valor de PORT é o valor onde a aplicação irá rodar localmente. Neste valor da variável de ambiente a aplicação irá rodar no caminho http://localhost:3001.

Heroku da aplicação

Para visitar a aplicação no heroku basta acessar o link: https://softeo-backend-humberto.herokuapp.com
Para visitar o frontend da aplicação no heroku basta acessar o link: https://softeo-frontend-humberto.herokuapp.com

Observação: Para acessar os dados do cliente pelo back-end é necessário o token que é gerado no momento do login.

---

Github da aplicação frontend

Link: https://github.com/Humberto-Bonadiman/softeo-frontend

---

Rodar o banco de dados com o docker

Rode o comando:

  npm run start-docker

Gere a migration do projeto

  npm run migrate

Inicie a aplicação:

  npm start

Documentação com Swagger

Para acessar a documentação pelo swagger rode o comando npm start e acesse o projeto via browser, no caminho http://localhost:3001/docs