Puppy Playdate

Does your dog seem bored? Are you curious about any dog park meet ups or social events near you? Puppy Playdate is designed to meet the need for dog socialization, allowing users to connect with nearby dogs for playdates, ensuring their pets enjoy regular and enriching social interactions. The app uses geolocation so you can peak at a map and see just how close your dogs new best friend might be. You can host a doggy meet up, receive invites to them, schedule a 1 on 1 meet up and more.

Come check out the app here!

• Insert link to deployment here.

Getting Started

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

This project uses Ruby version 3.2.2.

Database Setup

Change directories into the project: cd /puppy_playdate_be

Install all gems: bundle install

To initialize the database, run the following commands:

rails db:{drop,create,migrate,seed}

Schema

Running the Test Suite

To run the test suite, execute the following command:

bundle exec rspec

Running the Server

To run the server, execute the following command:

rails s

IMPORTANT: In order to make the Front End tests pass, you must run the backend server in the background.

Install Intructions

In terminal (bash or zsh):

git clone [email protected]:Puppy-Playdate/puppy_playdate_fe.git

git clone [email protected]:Puppy-Playdate/puppy_playdate_be.git

cd puppy_playdate_be

Open up a second terminal:

cd puppy_playdate_fe

In both terminals:

• bundle install

• rails s

  • The backend runs on 'http://localhost:3000/'
  • The frontend runs on 'http://localhost:5000/'

Gems

• Faraday gem to interact with APIs
• bcrypt
  • gem "bcrypt", "~> 3.1.7"
• JSONAPI Serializer gem for formatting JSON responses

Placed in group :test block:

• rspec-rails gem that is backbone of our testing architecture
• factory_bot gem to create models for testing data
• Faker gem to mock and stub test data
• SimpleCov gem for code coverage tracking
• ShouldaMatchers gem for testing assertions
• Capybara gem for end to end testing

Placed in group :development, :test block:

• Pry gem for debugging

Running the tests

bundle exec rspec

All tests should be passing.

API Endpoints

Utilize "http://localhost:3000/" to access ALL endpoints.

Puppy Playdate Endpoints:

For endpoint data please consult the spec/resquest files to see our mocked data.

User CRUD

• Users Index

  • GET api/v1/users

• User Show

  • GET api/v1/users/:id

• User Create

  • POST api/v1/users

• User Update

  • PATCH api/v1/users/:id
  • PUT api/v1/users/:id

• User Destroy

  • DELETE api/v1/users/:id

Dogs CRUD

• Dogs Index

  • GET api/v1/users/:user_id/dogs

• Dog Show

  • GET api/v1/users/:user_id/dogs/:id

• Dog Create

  • POST /api/v1/users/:user_id/dogs

• Dog Update

  • PATCH api/v1/users/:user_id/dogs/:id
  • PUT api/v1/users/:user_id/dogs/:id

• Dog Destroy

  • DELETE api/v1/users/:user_id/dogs/:id

Socials CRUD

• Socials Index

  • GET api/v1/users/:user_id/socials

• Socials Show

  • GET /api/v1/users/:user_id/socials/:id

• Socials Create

  • POST /api/v1/users/:user_id/socials

• Socials Update

  • PATCH /api/v1/users/:user_id/socials/:id
  • PUT /api/v1/users/:user_id/socials/:id

• Socials Destroy

  • DELETE /api/v1/users/:user_id/socials/:id

Contributors

• Tommy Takahashi

  • Tommy's LinkedIn
  • Tommy's Github

• Miranda Delaney

  • Miranda's LinkedIn
  • Miranda's Github

• Eric Belongea

  • Eric's LinkedIn
  • Eric's Github

• Blake Sergesketter

  • Blake's LinkedIn
  • Blake's Github

• Justin Lee

  • Justin's LinkedIn
  • Justin's Github