Giter Club home page Giter Club logo

recipes_drawer's Introduction

Recipes Drawer backend service

This application provides a REST interface to fetch recipes data from a Contentful provider. It wraps up everything configuration-wise and provides an easy and straightforward way to access recipe's well formatted JSON data.

You can run this application standalone but it is recommended to run it along with Recipes Drawer UI, which already has this application mapped into Docker Compose and everything needed to run both the backend and the frontend.

Configuration

This application has Docker and Docker Compose files to make it easy to get up and running.

First, clone this repo.

Important: It is required that you inform Contentful's credentials and configurations. The following set of variables should be informed within the docker-compose.yml file:

# docker-compose.yml

# ...
    environment:
      - CONTENTFUL_SPACE_ID=your_contentful_space_id
      - CONTENTFUL_ENVIRONMENT_ID=your_contentful_environment_id # usually master
      - CONTENTFUL_DELIVERY_TOKEN=your_contentful_delivery_token
      - CONTENTFUL_API_URL=contentful_url # usually cdn.contentful.com
# ...

Build the image running:

docker-compose build

Start the application running:

docker-compose up -d

Notes:

  • This runs in dettached mode, if you want to attach output to console, remove the -d.
  • Docker is mapping the application to localhost:9000, so please be sure that you don't have anything already mapped to that port.

Fetching recipes data

List all recipes

GET http://localhost:9000/recipes

Fetch by ID

GET http://localhost:9000/recipes/{id}

How to run the test suite

docker-compose run recipes_drawer_backend bundle exec rspec spec -f d

recipes_drawer's People

Contributors

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