Giter Club home page Giter Club logo

be_divercity_ld's Introduction

DiverCity_logo

Module 4 Capstone Back End Group Project

DiverCity: Inclusive Business Guide: back-end repo | front-end repo

Table of Contents
  1. Getting Started
  2. About This Project
  3. DiverCity Exposed Endpoints
    Available Endpoints
  4. What is next?
  5. Collaborators

Getting Started

Versions

  • Ruby 2.7.2
  • Rails 5.2.8

Gems

API | jsonapi-serializer | faraday | figaro |

CI/CD | GitHub Actions | Rubocop |

Testing | rspec-rails | pry | simplecov | factory_bot_rails | faker | vcr | webmock | shoulda-matchers | capybara |


Set Up

API Key

You will need to obtain and incorporate your personal API key:

  1. Visit Yelp Fusion Api to sign up for an account and get your secure API Key
  2. Complete local instalation following the instructions below
  3. Run bundle exec figaro install, this will create a hiddes config/application.yml file
  4. Run atom config/application.yml to open the hidden file
  5. Add yelp_key: Bearer your_key to this file so it can be accesses as this varible name through the application
  6. Close the file

Local set up

Open a terminal session and run the following commands:

  1. Clone this repository:[email protected]:Capstone-LGBTQ-BIPOC/BE_DiverCity.git
  2. Navigate to the newly cloned directory:cd Capstone-LGBTQ-BIPOC/BE_DiverCity
  3. If bundler is not installed run:gem install bundler
  4. To install the required Gems run:bundle install
  5. If errors occur, check for proper installation and versions of:bundler, ruby, and rails
  6. Set up the database locally with:rails db:{drop,create, migrate, seed}
  7. Open your text editor and check to see that schema.rb was created
  8. You may also run the RSpec test suite locally with the command bundle exec rspec to ensure everything is functioning as expected.

Project Description

DiverCity: Inclusive Business Guide API Endpoints is the Capstone project for students a the Turing School of Softwarre Design. This repo is the back-end that was designed to consume external APIs and expose relevant data to the front-end team in the format requested through the JSON contract.

Learning Goals for Project:

Explicit

  • Expose an API that consumes data from an external data
  • Use ***** RICH explain the mail and background workers
  • Determine completion criteria based on the needs of other developers
  • Research, select, and consume an API based on your needs as a developer

Implicit

  • Project planning
  • Reading/Writing documentation
  • Time Management/Prioritizing Work
  • Break down large project goals into manageable steps
  • GitHub workflow and project management tools

API Endpoints

Business index endpoint

API Endpoint: https://immense-falls-83363.herokuapp.com/api/v1/businesses?location=denver&category=food

image (6) image (7)

The Business show page endpoint

API Endpoint: https://immense-falls-83363.herokuapp.com/api/v1/businesses/5G2X2q9p7QFdm-LbyutltQ

image (3) image (4)

Posting business recommendations

API Endpoint: https://immense-falls-83363.herokuapp.com/api/v1/recommendations?business_id=5G2X2q9p7QFdm-LbyutltQ

image (10) image (11)

Get Businesses Recommendations

API Endpoint: https://immense-falls-83363.herokuapp.com/api/v1/recommendations

image (8) image (9)


What is next

Functionality built into the application that needs API endpoint exposure:

  • Endpoint to creator a user account
  • Endpoint for a user to add a recommendation for a business

Collaborators

๐Ÿ’ป Joseph Galvin | GitHub | LinkedIn |

๐Ÿ’ป Richard LaBrecque | GitHub | LinkedIn |

๐Ÿ’ป Tamara Dowis | GitHub | LinkedIn |

be_divercity_ld's People

Contributors

jwgalvin avatar wanderlust-create avatar richardlabrecque avatar dependabot[bot] 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.