GearMate

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Requirements
6. Contact

About The Project

GearMate is an application where users can rent out various types of gear, games, or hardware, that others may just need for a few days, or just want to test out! Currently, to rent outdoor gear, outdoor enthuiasasts must go to a large, corporate, recreational store to rent out low quality equipment for too high of prices. Now, people can rent out their gear to whoever may need it!

(Back to top)

Built With

(back to top)

Local Installation

1. Clone the repo

   git clone https://github.com/kylebrackman/GearMate.git

2. Change directories into /client [cd client] and run:

   npm install

3. Change directories into /backend and run:

    bundle install

    rails db:migrate

Docker Installation

4. To do the same in docker, create a .env file in root with the two variables:

POSTGRES_USER=your_username
POSTGRES_PASSWORD=your_password

5. There are two ways to run docker:

• Have docker installed or rancher desktop
• Run the following commands in order

 docker-compose build

 docker-compose up

 docker exec -it gearmate_iii-backend-1 bin/rails db:migrate

That last command will be dependant on what your container name is!

6. Option 2 is run the folling commands

cd client // to get into client folder
npm run docker:build
npm run docker:create-db [container_name] mydb // the container name could be gearmate it could be geatmate_iii...check on that!
npm run docker:migrate

7. Once this initial set-up is done then simply cd into client and run npm run docker:build or in terminal run the two docker commands in order: docker compose up && docker compose up

See notes.md for more helpful info.

(back to top)

Roadmap & Bugs

• Add request and approve flow to rental requests (in progress...).
• Add in payment gateway.
• Add user chat for coordinating item dropoffs/pickups.
• Fix Google Maps API issues.
• Add available and unavailable dates on each item calendar.
• Create "Items Being Rented" page.

(back to top)

Versions

• Ruby 3.3.5
• Rails 7.2.1
• React 18.3.1
• Postgresql (Postgresql@16, specifically)

Acknowledgements

• othneildrew Best README Template

Contact

Kyle Brackman - [email protected]

Project Link: https://github.com/kylebrackman/GearMate-III

(back to top)

GearMate