Você pode acessar a api, atravês do link abaixo:
🍀 NodeJs - Ambiente de execução javascript server-side.
🔺 AdonisJs - FrameWork baseado no Node, cuja a finalidade neste projeto é a construção de api's
👾 Heroku - Plataforma em nuvem, utilizado para deploy de diversas aplicações.
🛢️ Lucid Orm - Trás a api, uma forma mais enxuta de consultar o banco. Baseado no Knex
🔎 Vow - Utilizado para a execução de teste unitários e de integração.
Tomando como base do que seria de fato um ponto de venda, foi elaborado as tabelas e suas relações.
Antes de executar é necessario mudar as variáveis de ambiente, localizadas no arquivo .env, você pode mudar as configurações de acordo com as suas preferências.
# Clone o repositório
git clone https://github.com/Josuebmota/SmallPDV.git
# Vá para o diretório do arquivo
cd SmallPDV
# Faça o download das dependências
yarn or npm i
# Caso não tenha criado um banco em seu ambiente de teste
CREATE DATABASE SmallPDV
# Rode as migrations
adonis migration:run
# Efetue a inserção de dados
localizada SmallPDV/test/database/testDB.sql
# Start o projeto
adonis serve --dev
or
adonis serve --dev --debug
Caso queira testar as rotas criadas, é aconselhavel usar o Insomnia, pois todas a requisições já estão construidas e arquitetadas nesse ambiente. Nas etapas, é relatado o processo de sua configuração.
1 - Dê uma Fork na aplicação.
2 - Instale o Insomnia Designer.
3 - Gere um token de acesso, para o insomnia acessar seu github.
4 - Dentro do insomnia acesse Create/GitClone e atríbua as informações.
Afim de trazer entedimento de cada rota desta api, basta acessar a rota:
Homologação: http://smallpdv.herokuapp.com/swagger.json
Local: http://localhost:3333/swagger.json
Nessa rota, estará documentado o que cada função de um determinado controller ira efetuar.
Sinta-se a vontade de registrar um novo problema, com um respectivo título e descrição no repositório do SmallPDV. Se encontrar a solução, avaliarei seu Pull Request.
- As rotas de ForgotPassword e ResetPassword não foram implementadas ainda
- E a documentação do Swagger ainda está incompleta
Criado por Josué Batista Mota e Yvens Martins,
esse projeto está sobre MIT license 📃.