https://github.com/jhony2488/reservapp-back-end
Sistema de Reservas Online com Recomendação de Horários
https://github.com/jhony2488/reservapp-back-end
Last synced: 3 months ago
JSON representation
Sistema de Reservas Online com Recomendação de Horários
- Host: GitHub
- URL: https://github.com/jhony2488/reservapp-back-end
- Owner: jhony2488
- Created: 2023-11-29T17:50:47.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-08T23:49:12.000Z (over 1 year ago)
- Last Synced: 2025-01-06T10:48:12.473Z (4 months ago)
- Language: TypeScript
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
App de Sistema de Reservas Online com Recomendação de Horários RESERV Back End
Descrição:
Desenvolver um sistema de reservas online para um restaurante que não apenas permita aos usuários reservar uma mesa, mas também recomende horários alternativos se o horário desejado estiver indisponível. O sistema deve ser otimizado para garantir que o restaurante maximize a ocupação durante os horários de pico, sugerindo aos clientes os melhores horários alternativos.
Tabela de conteúdos
- [Sobre](#---vuttr)
- [Tabela de Conteudo](#tabela-de-conteudo)
- [Como usar](#como-usar)
- [Pre Requisitos](#pré-requisitos)
- [Instalação](#instalação)
- [Rodando a API](#-rodando-a-api)
- [Testes](#-testes)
- [Documentação](#----documentatação-da-aplicação)
- [Tecnologias](#-tecnologias)
Como usar
Pré-requisitos
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/), [PostgreSQL](https://www.postgresql.org/),[Docker](https://hub.docker.com/).
Além disto é bom ter um editor para trabalhar com o código como [VSCode](https://code.visualstudio.com/)
Instalação e rodar com o app sem docker
```bash
# Clone este repositório
$ git clone
# Acesse a pasta do projeto no terminal/cmd
$ cd ReservApp-Back-End
# Crie o arquivo .env e configure ele semelhante a o .env.exemplo
$ touch .env
# Instale as dependências
$ npm install || yarn install
# Baixar postgresql e rodar ele localmente
$
# rodar a aplicação em modo de desenvolvimento
$ npm run dev || yarn dev
# OU
# Gerar Build
$ npm run build || yarn build
# rodar a aplicação em modo de produção
$ npm run start || yarn start
```
🎲 Rodando a API em modo de desenvolvimento com docker
#### Instale o Node.js atravez do link abaixo caso ainda não o tenha instalado
- [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
#### Instale o Docker atravez do link abaixo caso ainda não o tenha instalado
- [https://hub.docker.com/](https://hub.docker.com/)
```bash
# Execute o docker compose no seu terminal/CMD
$ docker-compose up -d || docker compose up -d
# Execute as migrations
$ npm run migration:run || npm run migration:run
# O servidor inciará na porta:80 - acesse
# O banco de dados postgres inciará na porta:5432 - acesse
# Obs: caso o container node não rode, deixe o servidor rodando e rode localmente o app.
```
🛠 Testes
### Instale o Node.js atravez do link abaixo caso ainda não o tenha instalado
- [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
### Instale o PostgresSQL atravez do link abaixo caso ainda não o tenha instalado
- [https://www.postgresql.org/](https://www.postgresql.org/)
```bash
# Executar os testes
$ npm run test || yarn test
# Executar testes de estresse na API
$ npm run test-stress || yarn test-stress
```
Documentação da aplicação
```bash
# Executar o a API
$ npm run dev || yarn dev
# O servidor inciará na porta:80 - acesse a documentação
```
### Acesse a documentação da localmente
- [http://localhost:80/documentation/](http://localhost:80/documentation/)
🛠 Tecnologias
As seguintes ferramentas foram usadas na construção do projeto:
- [Node.js](https://nodejs.org/en/)
- [TypeScript](https://www.typescriptlang.org/)
- [Express.js](https://expressjs.com/pt-br/)
- [Typeorm](https://typeorm.io/)
- [Jest](https://jestjs.io/)
- [JWT](https://jwt.io/)
- [Eslint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [PostgreSQL](https://www.postgresql.org/)