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
• Instalação
• Modo de usar
• Construído Com
• Autor

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

• Javascript
• Node.js
• MongoDB
• Typescript
• Jest

Autor

• Jônathas Gouveia

Licença

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