Skip to content

sheesh19/travelmate-up

Repository files navigation

Travelmates Documentation

Travelmates is an app to enable solo travelers- from finding mates and events to join to getting inspiration for solo trips, Travelmates is the best mate to have when planning a solo trip.

(Travelmates is mainly a passion project to test new features.)

Travelmates is a PWA- you can add the app to your home screen.

If you have an iPhone:

1. Open the PWA on Safari.
2. Tap the 'Share' button and scroll down to 'Add to Home Screen'.

If you have an Android:

1. Open the PWA on Chrome.
2. Open the menu with the three dots at the top of Chrome.
3. Scroll down to 'Add to Home Screen'.

Table of Contents

  1. Environment Setup
  2. TravelMates Consumer Website
  3. External Services

Environment Setup

This application is using:

  • Ruby 3.1.2
  • rbenv 1.1.2
  • Rails 6.0.3.4

To use this application via Mac, please follow the below steps in your terminal.

To download Homebrew, the package manager we are using, run the following in your terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
brew update

Install rbenv to manage your ruby version:

brew install rbenv
rbenv install 3.1.2

Set the correct ruby version:

rbenv global 2.6.6

OR, if you are in your project directory and only want to change the ruby version locally:

rbenv local 2.6.6

Install postgres, the database the application is leveraging:

brew install postgresql
brew services start postgresql

In your terminal, run the following the clone the project onto your local machine:

git clone [email protected]:sheesh19/travelmate-up.git
  • For the final setup for the packages, gems, and seed file, run the following:
bundle install
yarn install

rails db:create
rails db:migrate
rails db:seed

Travelmates Features

Users for the consumer website are:

  • solo travellers looking for mates to meet up with, ideas of activities from other solo travellers, ideas for solo events or trips

The consumer facing website is where users are able to:

  • find curated experiences from other solo travellers
  • track, post, or share their own solo trips
  • add events for people to join
  • manage mate up requests: approve, cancel, decline
  • message their new mates
  • sign up for other solo travellers' events
  • search through activities, locations, or events for inspiration

Other features include:

  • autocomplete for locations and images via Google Places
  • maps generated from Mapbox
  • asset management via Cloudinary
  • messaging via ActionCable
  • video chatting via Vonage / OpenTok

External Services

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors