Welcome to the Coffee Finder App. This is an app that can be used to add, find, and review coffees. Coffees can have different stores as well as listed locations. The base app does not contain any data, so the first thing to do would be to start adding coffees. You can add some of your favorites and leave reviews.
Admin accounts can be created as well with a check of the checkbox.
Github can also be utilized in order to login.
Steps for getting started:
- Git clone the project
- Run bundle install, then rails db:migrate and rails db:seed if you'd like to get some test data into the app.
- rails s to start the server and then navigate to http://localhost:3000/ to get started.
Logging in with Github:
- Create an OAuth App first by going to your Github profile and then Developer Settings > OAuth Apps > New OAuth App
- Application name can be anything
- Homepage URL: "http://localhost:3000"
- Authorization callback URL: "http://localhost:3000/auth/github/callback"
- Register application
- Note down Client ID and then click to generate a new client secret. The ID and secret will be what you use for Key and Secret in your env file.
- Create a .env file at the root of the project
- Enter the following into the .env file (using your Client ID and generated secret in place of the text in the brackets) GITHUB_KEY=[Client ID] GITHUB_SECRET=[Secret]
- Save the file
- If done successfully, you should now be able to log in to the application with your Github account.