Code Monkey home page Code Monkey logo

jonathasgouv / citei-api Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 1.9 MB

Citei é uma API open source e de uso gratuito de citações/frases. A API retorna citações/frases em ordem, aleatórias, por autor ou por categoria. A API conta atualmente com quase 600 mil frases.

Home Page: https://citei.herokuapp.com/docs/

License: GNU General Public License v3.0

Shell 0.14% JavaScript 41.52% TypeScript 58.34%
api rest quotes quotes-api frases frases-api citacoes citacao citacao-api mongodb

citei-api's Introduction

Citei

Version 1.0.0

Citei é uma API open source e de uso gratuito de citações. A API retorna citações em ordem, aleatórias, por autor ou por categoria. A API conta atualmente com quase 600 mil frases. Se você quer construir sua própria versão da API continue lendo, caso contrário leia a documentação e aprenda como usá-la.

Conteúdos

Começando

Essas instruções fornecerão uma cópia do projeto instalado e funcionando em sua máquina local para fins de desenvolvimento e teste.

Instalação

Execute os comandos a seguir e você terá uma versão local do projeto em execução.

$ git clone https://github.com/jonathasgouv/citei-api
$ cd citei-api/
$ npm install

Renomeie o arquivo .env.example para .env e preencha as variáveis de ambiente. Pronto, agora basta iniciar o server de desenvolvimento com:

$ npm run dev

😀

Para popular a database siga o esquema de quotes disponível na documentação.

Modo de usar

Confira os endpoints disponíveis na documentação.

Construído com

Autor

Licença

Esse projeto está licenciado sob a licença GPL-3.0 - veja o arquivo LICENSE para mais detalhes.

citei-api's People

Contributors

alcidesa avatar dependabot[bot] avatar diego3g avatar jonathasgouv avatar jpedroschmitz avatar

Stargazers

 avatar

Watchers

 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.