Trash2Treasure API - version 1.0.0

Backend API of the final project for the Lighthouse Labs Web Development Program created by Marcos Spomberg, Tony Walker and Siyi Xie.

Trash2Trasure

Trash2Treasure is a platform for users to list items (treasures) that are being left for donation in public spaces. It realies heavily on geolocation and the Google Maps API. Users are able to add and claims donations/treasures, comment on each donation and search by location and item name.

To be used in conjunction with the frontend app.

Created with Ruby 2.6.6 and Rails 6.1.5.

System dependencies

• Postgres
• Puma
• JBuilder
• Faker
• HTTP
• Rack-CORS
• Google Maps

API Setup

1. cd into the directory
2. Run bundle install to install required gems
3. Rename config/local_env.example.yml to config/local_env.yml and add a valid Google Maps API key string.
4. Run rails db:setup to create the database, load the schema and initialize the seed data.
5. Run rails start to start the API.

Frontend Setup

1. cd into the directory
2. Run npm install to install the dependencies.
3. Rename .env.development.example.local as .env.development.local and add a valid Google Maps API key string.
4. Run npm start