DiverCity: Inclusive Business Guide: back-end repo | front-end repo
Table of Contents
- Ruby 2.7.2
- Rails 5.2.8
API | jsonapi-serializer | faraday | figaro |
CI/CD | GitHub Actions | Rubocop |
Testing | rspec-rails | pry | simplecov | factory_bot_rails | faker | vcr | webmock | shoulda-matchers | capybara |
You will need to obtain and incorporate your personal API key:
- Visit Yelp Fusion Api to sign up for an account and get your secure API Key
- Complete local instalation following the instructions below
- Run
bundle exec figaro install
, this will create a hiddes config/application.yml file - Run
atom config/application.yml
to open the hidden file - Add
yelp_key: Bearer your_key
to this file so it can be accesses as this varible name through the application - Close the file
Open a terminal session and run the following commands:
- Clone this repository:
[email protected]:Capstone-LGBTQ-BIPOC/BE_DiverCity.git
- Navigate to the newly cloned directory:
cd Capstone-LGBTQ-BIPOC/BE_DiverCity
- If bundler is not installed run:
gem install bundler
- To install the required Gems run:
bundle install
- If errors occur, check for proper installation and versions of:
bundler
,ruby
, andrails
- Set up the database locally with:
rails db:{drop,create, migrate, seed}
- Open your text editor and check to see that
schema.rb
was created - You may also run the RSpec test suite locally with the command
bundle exec rspec
to ensure everything is functioning as expected.
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.
- 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
- Project planning
- Reading/Writing documentation
- Time Management/Prioritizing Work
- Break down large project goals into manageable steps
- GitHub workflow and project management tools
API Endpoint: https://immense-falls-83363.herokuapp.com/api/v1/businesses?location=denver&category=food
API Endpoint: https://immense-falls-83363.herokuapp.com/api/v1/recommendations?business_id=5G2X2q9p7QFdm-LbyutltQ
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
๐ป Joseph Galvin | GitHub | LinkedIn |