Skip to content

eduardor2m/reservify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hotel Room Reservation API - Reservify

Desenvolvido por: Eduardo Melo (https://github.com/eduardor2m)

Uma API de reserva de quartos para hotéis com autenticação e diferentes níveis de usuário. Este projeto é um exemplo prático de como criar uma API robusta em Go (Golang) usando autenticação JWT e armazenamento de dados no PostgreSQL.

Recursos

  • Autenticação segura usando tokens JWT (JSON Web Tokens).
  • Diferentes níveis de usuário: Administrador e Cliente.
  • Listagem e detalhes de quartos disponíveis.
  • Reserva, atualização e cancelamento de reservas.
  • Gerenciamento de quartos e reservas para administradores.

Pré-requisitos

Instalação

  1. Clone este repositório:
git clone https://github.com/eduardor2m/reservify.git
  1. Acesse o diretório do projeto:
cd reservify
  1. Instale as dependências:
go get ./...
  1. Configure as variáveis de ambiente:

Renomei o arquivo .env-example para .env no diretório ./cmd/application/ do projeto e configure as seguintes variáveis:

# SERVER
SERVER_PORT=8080

# DATABASE
DB_NAME=CHANGE-ME
DB_USER=CHANGE-ME
DB_PASSWORD=CHANGE-ME
DB_HOST=CHANGE-ME
DB_PORT=5432

# JWT
JWT_SECRET=CHANGE-ME

Uso

  1. Execute a aplicação:
go run ./cmd/application/main.go
  1. Acesse a API em http://localhost:8080/api/docs/index.html.

  2. Consulte a documentação interativa da API para obter detalhes sobre os endpoints e como usá-los.

Documentação

A documentação da API foi gerada automaticamente e está disponível em http://localhost:8080/api/docs/index.html após iniciar a aplicação.

Contribuição

Sinta-se à vontade para contribuir com melhorias, correções de bugs ou novos recursos. Basta seguir as diretrizes de contribuição neste arquivo.

Licença

Este projeto está licenciado sob a Licença XYZ.


Lembre-se de substituir `[Seu Nome]`, `[SEU_USUARIO]`, `[nome_do_banco_de_dados]`, `[seu_segredo_jwt]` e outras informações relevantes com os detalhes do seu projeto. Certifique-se de incluir um arquivo de licença e um arquivo `CONTRIBUTING.md` para orientações sobre como os outros podem contribuir para o seu projeto.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages