The project is named "Brew Compass".
The system is designed let users track their coffee consumption and preferences. It allows them to build up a taste profile to figure out their preferences. It also helps to hone your espresso shot pulling skills by providing tips.
- Ruby on Rails
- Postgres
- nginx
- puma
graph TD;
User-->|has_many|BrewingMethod
User-->|has_many|Beans
User-->|has_many|Brew
BrewingMethod-->|has_many|Brew
Beans-->|has_many|Brew
Brew-->|has_one|EspressoCompass
Brew-->|has_one|TasteCompass
All modern browsers are supported.
``` brew update --system brew upgrade ruby-build git clone http://github.com/RoleModel/brew_compass cd brew_compass rbenv install gem install bundler bundle install ```
rails s
rake
- Rubocop linter
- App Status Page will give you information about what is running.
- Alternatively, you can ssh in and check that the application server and web server are both running.
Due to the nature of this application, End User tests are...
Due to the nature of this application, unit tests are prominent and handle most of the confidence building and documentation needs of the system below the user interface.
At this point, no other tests are being employed. However, one might consider performance tests or other categories and describe the reasons here
Which tools are we using?
Github Actions is being used for CI. It is set up to run the tests on every push to the repository.
To begin a new feature run, git checkout -b <linear-card-branch>.
When finished with the feature and the code has been reviewed, the commits should be squashed before merging.
main is always deployed to production. The staging branch is deployed to staging.
```
git checkout main
git tag 2016-05-16 # {date} YYYY-MM-DD
git push --tags
```
The application is deployed to Heroku. They are also hosting the DNS. We certificate was received from Let's Encrypt.
- Jeremy Walton - 919-621-5974
Copyright (c) 2025 Closed Source @JeremyWalton