uharston / pooch

A dog adoption search engine powered by the Petfinder API.

A search engine for Dogs up for adoption in cities around the USA.

🐶 Click here 🐶 to go to the live build.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You must be running Ruby 2.6.1 and Rails 6.0.3.2 . One way to accomplish this is to use Ruby Version Manger(rvm).

rvm install "ruby-2.6.1"
rvm use 2.6.1
gem install rails -v 6.0.3.2

Installation

Start the Back End

Fork and clone the repository using your preferred method.

$ cd back-end-api

Then load all of the dependencies...

$ bundle install 

Create a development database

$ rake db:create 

$ rake db:seed 

$ rake db:migrate 

Start local server

$ rails server

Start the Front End

From the root of the repository

$ cd front-end 

Load the dependecies

$ yarn 

Start the local server

$ yarn start 

Tech Stack Used

- Ruby 2.6.1 
- Rails 6.0.3.2
- React.js
- Redux 
- Bundler 
- HTML5
- CSS3
- Bootstrap
- Sqlite - Development Database
- Postgres - Production Database 
- Heroku - Deployment Service 
- Netlify - Deployment Service 

Contributing

Contributions are always welcome.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License