Skip to content

sicknacco/lend-a-toolza-fe

 
 

Repository files navigation

Contributors Forks Stargazers Issues

Lend-A-Toolza

About This Project

Important to Note

This is an SOA app and needs both this repo (front end) AND GitHub (back end) in order to be fully functioning.

Mod 3 Group Consultancy Project

Lend-A-Toolza is a crowdsourced tool lending library web application. Designed for folks looking to borrow a particular tool within any given area/location. Lend-A-Toolza has the ability for registered users to upload their lendable tool with a picture, a description of the tool and a borrowing period as well as choose to borrow from a list of available tools in their area.

Built With

  • Ruby
  • Postgresql
  • Render
  • AWS
  • Rails
  • Visual Studio Code
  • Postman Badge
  • Love

Running On

  • Rails 7.0.6
  • Ruby 3.2.2

Getting Started

To get a local copy, follow these simple instructions

Installation

  1. Fork the Project
  2. Clone the repo
git clone [email protected]:NickTassinari/lend-a-toolza-fe.git
  1. Install the gems
bundle install
  1. Create the database
rails db:{create,migrate}
  1. Add Figaro
bundle exec figaro install
  1. Add environment variables to application.yml file
  • Navigate to the application.yml file in the config directory
  • Add the following to the file
#application.yml
GOOGLE_CLIENT_ID: 
GOOGLE_CLIENT_SECRET:
AWS_ACCESS_KEY: 
AWS_SECRET_ACCESS_KEY: 
BUCKET_NAME: 
AWS_REGION: 
  1. Get your API key at: https://code.google.com/apis/console/ Note the Client ID and the Client Secret.
- For more details, read the Google docs: https://developers.google.com/accounts/docs/OAuth2
    - Put your Client ID after `GOOGLE_CLIENT_ID:`
    - PUT you CLIENT SECRET after `GOOGLE_CLIENT_SECRET:`
- Create your AWS S3 bucket with these instructions: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html
  - Put the relavent information into the application.yml file for `AWS_ACCESS_KEY: AWS_SECRET_ACCESS_KEY: BUCKET_NAME: AWS_REGION:` 
  1. Run Tests in the terminal to verify everything was set up correctly
#terminal
bundle exec rspec
  • All tests should be passing
  1. Run Rails Server from the terminal to verify page is loading
#terminal
rails s
  • Open a web browser and navigate to http://localhost:5000
  • The welcome page should display
  • Note: To be able to have full functionality of the site you will also need to setup the backend repo, setup instructions can be found here: lend-a-toolza

### <b>Contribute your own code</b>
1. Create your Feature Branch 

#terminal git checkout -b feature/AmazingFeature

2. Commit your Changes 

#terminal git commit -m 'Add some AmazingFeature'

3. Push to the Branch 

#terminal git push origin feature/AmazingFeature

4. Open a Pull Request

How To Use Lend-A-Toolza

Login with the Login Button and Sign in with Google welcome screen Not sure what tools you need for your project? Ask our OpenAI for a suggestion of tools to use welcome logged in This page lists potential tools for your project and allows you to search for tools in your area chat results Search results from your area and request to borrow search results If we don't have the tool you're looking for you can search for a hardware store in your area that might store search Here is the results for the store search store results Click on My Tool Shed and you will be brought to your dashboard where you can see the tools you own, tools you have borrowed and the ability to add a tool tool shed This is the add tool form add tool

Schema

    t.string "name"
    t.string "email"
    t.string "token"
    t.string "google_id"
    t.string "location"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false

Contributing contributions welcome

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Authors

  • Crow Rising GitHub LinkedIn
  • Nick Sacco GitHub LinkedIn
  • Nick Tassinari GitHub LinkedIn
  • Javen Wilson GitHub LinkedIn

Planning Tools

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 68.0%
  • HTML 30.8%
  • Other 1.2%