Giter Club home page Giter Club logo

bible-edge's Introduction

API Bíblia versão NVI Build Status

accessibility text

Este projeto foi desenvolvido como objeto de estudos do desenvolvimento de API's utilizando NodeJs e foi baseado na série de screencasts do Fabio Vedovelli

A versão NVI utilizada foi baseada neste Repositório da Bíblia

Objetivo

API responsável por obter as passagens da Bíblia

O frontend deste projeto bible-vue foi desenvolvido com VueJs.

Rotas

  • GET /books Obtém a lista de livros disponíveis
  • GET /books/{:bookId}/chapters Obtém a lista de capítulos disponíveis de um livro
  • GET /books/{:bookId}/chapters/{:chapterId}/verses Obtém a lista de versículos de um livro e capítulo
  • GET /books/{:bookId}/chapters/{:chapterId}/verses/{:verseId} Obtém um versículo
  • GET /passages/:id Obtém uma passagem pelo ID
  • GET /passages/:id/next Obtém a pŕoxima passagem pelo ID
  • GET /passages/:id/previous Obtém a passagem anterior pelo ID

Pré-requisitos

  • Node.js versão 8 ou superior;
  • Nodemon - npm i -g nodemon
  • pm2 - npm i -g pm2 para produção

Começando

  1. Faça o clone do repositório e no terminal navegue até a pasta;
  2. Instale as dependências do projeto com npm install;
  3. Faça uma cópia do .env.example com o nome .env e adicione as informações de conexão com seu banco de dados MySQL (produção e teste).
  4. Na pasta sql se encontra o arquivo: nvi.sql. Utilize-os para criar o banco de dados, tabelas e inserção de dados;
  5. Rode o servidor de desenvolvimento com npm run dev ou modo produção com npm run production;
  6. Rode os testes com npm test. Para observar os arquivos durante o desenvolvimento utilize npm test -- --watch;
  7. O endpoint do serviço estará disponível em http://localhost:3003 .

Rodando com Docker

  • Criar a imagem

docker build -t bible-edge:latest

  • Criar Container

docker run -p 8080:8080 -d -t bible-edge:latest

  • Iniciar bash a partir do Container

docker exec -it /bin/bash

Sugestão

Utilize o Postman para testar suas chamadas. https://www.getpostman.com/.

Tecnologias

  • MySQL: Banco de dados relacional;
  • NodeJs Framework desenvolvimento Javascript.

bible-edge's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar rribeiro1 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.