Laranjal API

Projeto   |    Tecnologias   |    Serviços Utilizado   |    Getting Started   |    Como usar   |    Features   |    Licença

💻 Projeto

Laranjal API é uma API para efetuar reservas de mesas de escritório.

Esse projeto foi desenvolvido com o objetivo de solucionar o desafio proposto no Hackathon do Programa de Formação da FCamara.

Aproveite para conferir também o Front-end desenvolvido, clicando aqui.

Confira como foi o processo de desenvolvimento e muito mais acessando o artigo criado pelo nosso UX no Medium através deste link !

🚀 Tecnologias

O projeto foi desenvolvido com as seguintes tecnologias:

• Node.js
• Express
• Supabase
• PostgreSQL
• Knex
• Bcrypt
• JWT (JSON Web Token)
• Swagger

👨‍🔧 Serviços Utilizado

• GitHub
• Supabase
• Swagger

🎮 Getting Started

Se você tem interesse em executar em modo de desenvolvimento, pode começar clonando o repositório utilizando HTTP ou a chave SSH.

• Abra o terminal do Git Bash
• Digite git clone
• Insira o HTTP ou a chave SSH (no windows, shift + insert para colar no terminal do Git)
• Você encontra esse HTTP ou a chave SSH clicando em Code no canto direito superior deste repositório

• Depois de clonar você pode abrir o projeto na sua IDE e digitar os codes abaixo no terminal da IDE

npm i Para instalar as dependências do projeto.

npm run dev Para rodar a aplicação no modo de desenvolvimento.

Acesse http://localhost:8000 para visualizar no navegador.

Você pode utilizar o Insomnia (ou outra ferramenta similar) para testar as rotas da aplicação.

Dependências

• Express
• uuid
• Cors
• Swagger-ui-express
• Csv-parse

Dependências de Desenvolvimento

• Nodemon

📌 Como usar

1 - Abra o projeto na sua IDE

2 - Execute npm run dev no terminal

3 - Utilize o Insomnia para testar as rotas da aplicação

4 - Você também pode acessar a rota contendo a documentação do projeto em http://localhost:8000/api-docs/

🕵 Features

As principais features da aplicação são:

• Criar usuários
• Listar usuários
• Atualizar dados dos usuários
• Login
• Criar agendamentos
• Listar agendamentos
• Remover agendamentos
• Cadastrar unidades
• Atualizar unidades
• Remover unidades
• Autenticação de usuário através de Token

📝 License

Este projeto está sobre a licença MIT.

Em caso de bugs sensíveis, como vunerabilidades na segurança, gentileza contatar deywerson.pereira@gmail.com diretamente ao invés de utilizar um rastreio de problemas. Nós agradecemos seu esforço em melhorar a segurança e privacidade deste projeto!

---

Gentileza siga-nos no GitHub e junte-se a nós! Obrigado pela visita & Happy Coding

Feito com ♥ by Squad-38

Membros:
Deywerson Pereira - Dev FullStack
Bruno Sousa - Dev FullStack
Cristiano Rodrigues - Dev FullStack
Lucas Jurado - UX/UI Design