stay booker hotel booking express api

Stay Booker Hotel Booking Express API

Bem -vindo ao Repositório API do Stay Booker Hotel Booking Express. Esta API serve como a espinha dorsal para a reserva de reserva de Hotel Booker, fornecendo uma solução robusta de back -end para gerenciar reservas de hotéis, contas de usuário e muito mais. Construído com o Express.js e integrado ao MySQL através do Sequelize, este projeto foi projetado para oferecer uma plataforma perfeita e eficiente para aplicativos de reserva de hotéis.

Começando

Pré -requisitos

• Node.js (V16 ou posteriormente recomendado)
• Mysql
• Git
• Postman (para testes de terminais da API)

Configuração do ambiente

1. Clone o repositório

git clone https://github.com/iZooGooD/stay-booker-hotel-booking-express-api.git
cd stay-booker-hotel-booking-express-api

2. Instalar dependências

npm install

3. Configure mysql

Verifique se o MySQL está instalado no seu Windows/Linux/Mac. Crie dois bancos de dados: um para produção e outro para teste.

 CREATE DATABASE staybooker_prod ;
CREATE DATABASE staybooker_test ;

4. Configure variáveis ​​de ambiente

Copie o arquivo .env.example para um novo arquivo chamado .env e atualize -o com suas configurações de banco de dados MySQL e outras configurações.

 # Development Environment
DEV_DB_HOST=localhost
DEV_DB_USER=yourusername
DEV_DB_PASS=yourpassword
DEV_DB_NAME=staybooker_test

# Production Environment
PROD_DB_HOST=localhost
PROD_DB_USER=yourusername
PROD_DB_PASS=yourpassword
PROD_DB_NAME=staybooker_prod

# JWT Secret
JWT_SECRET=jwtsecretforproject

Executando o aplicativo

Ao iniciar o aplicativo, a sequelização criará automaticamente as tabelas necessárias no banco de dados especificado.

npm run start:dev

Testando pontos de extremidade da API com Postman

Para garantir as funções da API como esperado, recomendamos o uso do Postman para testar os pontos de extremidade. Importe a coleção Postman fornecida (se disponível) para começar rapidamente a testar a funcionalidade da API, incluindo autenticação de usuário, listagens de hotéis, reservas e muito mais.

Sequelizar e MySQL

Este projeto usa o Sequelize, um Node.js ORM baseado em promessa, para gerenciamento de banco de dados. Sequelizar simplifica as interações MySQL, permitindo fácil manipulação de dados e consultar através de modelos que representam tabelas de banco de dados. A configuração para sequelizar é encontrada no config/config.js , e os modelos estão localizados no diretório models .

Contribuindo

Congratulamo -nos com contribuições para a API Stay Booker Hotel Booking Express! Seja adicionando novos recursos, corrigindo bugs ou melhorando a documentação, sua ajuda é apreciada. Leia nossas diretrizes contribuintes (a serem criadas) para obter mais informações sobre como contribuir com eficiência.

Qualidade de código

A qualidade do código é muito importante neste projeto. Nós nos esforçamos para manter altos padrões de qualidade e legibilidade do código. Certifique-se de que suas contribuições sigam a esses padrões e sejam bem testadas.

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença para obter detalhes.