Giter Club home page Giter Club logo

recipe-api's Introduction

Recipe API

https://edjdc.github.io/recipe-api

Utilização

Para executar a aplicação é necessário ter o docker e o docker-compose instalados.

Execute o comando docker-compose up --build para iniciar a aplicação.

Após a aplicação tiver sido iniciada é possível acessar o link http://localhost:8080/recipes/ para realizar consultar na API.

Endpoints:

GET /health - Retorna o status da aplicação

GET /metrics - Retorna métricas da aplicação

GET /recipes/?i={ingredient_1},{ingredient_2},{ingredient_3} - Retorna as receitas para os ingredientes informados (máximo 3)

Desenvolvimento

Para executar a aplicação localmente é necessário criar um arquivo .env na raiz do projeto com uma variável GIPHY_API_KEY preenchida com um token de acesso da API do giphy.

O arquivo docker-compose.yml possui um token que pode ser utilizado para testes.

Comandos

Install

yarn install

Start

yarn start

Start - prod

yarn start:prod

Build

yarn build

Tests

yarn test

Tests - coverage

yarn test:coverage

Prettier - format

yarn prettier:format

Prettier - check

yarn prettier:check

Lint

yarn lint

recipe-api's People

Contributors

edjdc 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.