A location-based friend finding app to connect dog owners for playdates!
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Setup
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgements

About The Project

This app was built as part of Lighthouse Labs' final project. The project was bootstrapped with Create React App for the frontend, Rails 6 for the backend, and PostgreSQL as the database.

New in town? Want to meet more new dog-owning friends? This location based app helps you find dogs and dog-friendly places nearby. Find stuff to do and playmates - for you and your dog!

Built With

• React
• Ruby on Rails
• Google Maps API
• React Router
• PostgreSQL
• Semantic UI

Getting Started

To get a local copy up and running follow these simple example steps!

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• react 16.14.0
• ruby 2.7.2
• rails 6.1.2
• axios 0.21.1
• react router 5.2.0
• react-google-maps/api 2.1.1

Installation

1. Get a free API Key for Google Maps at Google Maps API key
2. Clone the repo

   git clone https://github.com/audrey-audrey/fetch_v2

3. Open client folder and install NPM packages

   npm install

4. Inside the client folder, enter your API in .env file

   const REACT_APP_API_KEY = 'ENTER YOUR API';

5. Open backend folder and install gems

   bundle install

Setup

From the root directory, type the following commands:

cd backend/

rake db:reset

rails s -b 0.0.0.0

From the root directory in a new terminal, type the following commands:

cd client/

npm start

Usage

User can sign up for an account or log in to an existing account from the landing page.

After logging in, user can see others in their area. Current user's marker is coloured yellow, and other users are orange. Clicking on a marker will open an info window with a profile photo, approximate distance away, an option to favourite the user, and a button to the user's profile page.

Clicking on the burger icon on the top left corner will open a side navigration bar where users can navigate to different pages.

User can navigate to their own Profile page, where they are able to edit information, such as their name, dog information, address, email, etc. (Currently working on a feature where user will be able to upload photos)

User can also navigate to their Favourites page, where they can view other profiles that they have saved. Navigate to the Conversations page to view messages and chat with other users to set up a meeting.

Roadmap

Future developments for the app includes:

1. Using yelp's API to display nearby dog-friendly places for users
2. Implementing websockets for updates between users
3. Integrating a scheduler for seamless meetup planning

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Audrey Untung - @linkedin

Project Link: fetch_vs

Acknowledgements

• React Burger Menu
• Nuka Carousel
• Animation
• Font Awesome