Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chiditarod/dogtag
Racer registration and management application for the CHIditarod. Integrates with Stripe and Classy.
https://github.com/chiditarod/dogtag
heroku rails rails4 registration ruby ruby-on-rails signup ticketing-system
Last synced: 26 days ago
JSON representation
Racer registration and management application for the CHIditarod. Integrates with Stripe and Classy.
- Host: GitHub
- URL: https://github.com/chiditarod/dogtag
- Owner: chiditarod
- License: gpl-3.0
- Created: 2013-09-24T04:39:55.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T09:16:15.000Z (3 months ago)
- Last Synced: 2024-11-20T14:50:46.190Z (about 1 month ago)
- Topics: heroku, rails, rails4, registration, ruby, ruby-on-rails, signup, ticketing-system
- Language: Ruby
- Homepage: http://chiditarod.org
- Size: 1.45 MB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
dogtag
======
*dogtag is a Ruby on Rails application that registers user and teams for the annual [CHIditarod](http://chiditarod.org) urban shopping cart race and epic mobile food drive. The code is 100% open-source, runs on Heroku, and has processed more than $100,000.*
[](https://codeclimate.com/github/chiditarod/dogtag/coverage)
[](https://codeclimate.com/github/chiditarod/dogtag)
Integrations
--------
- Payments/Refunds via the Stripe API
- Fundraising campaign automation via the Classy API
Requirements
------------
- App Server like Heroku
- Redis
- PostgreSQL
- SMTP Server
Runtime Environment Variables
-----------------------------
```
DATABASE_URL=postgres://postgres:123abc@localhost:5432
STRIPE_PUBLISHABLE_KEY=pk_test_...
STRIPE_SECRET_KEY=sk_test_...
CLASSY_CLIENT_ID= # optional
CLASSY_CLIENT_SECRET= # optional
CLASSY_ORGS= # comma-separated list of classy organization ids the client has access to. used to cache org members
ROLLBAR_ACCESS_TOKEN= # optional
DEFAULT_FROM_EMAIL # e.g. [email protected]
SMTP_DOMAIN # e.g. heroku.com
SMTP_HOST # e.g. smtp.foo.tld
SMTP_PORT
SMTP_USERNAME
SMTP_PASSWORD
```
## Custom questions using jsonform
Each race has a `jsonform` field. This field can contain a [jsonform](https://github.com/jsonform/jsonform) schema that is consumed and rendered as questions to the end-user during their team signup. Their responses are then saved into their team record and are included when exporting a CSV.
- __NOTE:__ There's a hack that requires addition to `HACK_PARAM_WHITELIST` any time a new jsonform question is added. See [https://github.com/chiditarod/dogtag/issues/40](https://github.com/chiditarod/dogtag/issues/40).
- For example jsonform data, see [github](https://github.com/chiditarod/dogtag/tree/master/examples/jsonform)
## Developer Setup
*Tested against MacOS Mojave (10.14.2)*
### Prerequisites
- [Xcode](https://itunes.apple.com/us/app/xcode/id497799835)
- [Docker](https://docs.pie.apple.com/artifactory/docker.html)
- [Homebrew](https://brew.sh/)
### Install Ruby
```bash
brew install rbenv
rbenv install $(cat .ruby-version)
gem install bundler
```
### Install
#### MacOS 12.6
```sh
xcode-select --install
softwareupdate --all --install --force
brew install readline openssl v8 libpq
gem install libv8 --platform="x86_64-darwin-20"
bundle config --local build.pg --with-opt-include="/opt/homebrew/opt/libpq/include" --with-opt-lib="/opt/homebrew/opt/libpq/lib"
bundle install
docker-compose up -d db
bundle exec bin/rails db:migrate RAILS_ENV=test
rspec
```
#### MacOS 12.1
```sh
xcode-select --install
softwareupdate --all --install --force
brew install readline openssl v8 libpq
gem install libv8 --platform="x86_64-darwin-20"
bundle install
bundle exec bin/rails db:migrate RAILS_ENV=test
rspec
```
#### Prior MacOS Versions
```sh
brew install libffi libpq
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/usr/local/opt/libffi/lib/pkgconfig"
bundle config --local build.ffi --with-ldflags="-L/usr/local/opt/libffi/lib"
bundle config --local build.pg --with-opt-dir="/usr/local/opt/libpq"
bundle install
```
### Create an `.env` file for local development
This file is used when booting Rails outside of Docker. Customize `.env` with `STRIPE_PUBLISHABLE_KEY` and `STRIPE_PUBLISHABLE_KEY` entries, which are currently required to boot the app.
```bash
cp .env.example .env
```
## Local Development
### Build and run all containers
This will also create the `dogtag_test` and `dogtag_development` databases and will build and boot mailcatcher.
docker-compose up -d
### Run the test suite
docker-compose run web bundle exec rspec # from within the container
bundle exec rspec # or from the console
### Mailcatcher
The `mailcatcher` gem gets built into a docker image and deployed in the
docker compose cluster. It exposes an SMTP port on `1025` and a web UI on `1080`.
## Database
### Create and Migrate
Via docker:
docker-compose run web bundle exec rake db:migrate
docker-compose run -e RAILS_ENV=test web bundle exec rake db:migraten
Or via the command line:
bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake db:migrate
### Connect to postgres inside container
docker-compose exec db psql -U postgres
### Restore postgres db from a dump file
```bash
docker cp /local/file.dump $(docker-compose ps -q db):/file.dump
docker-compose exec db pg_restore -U postgres --verbose --clean --no-acl --no-owner -h localhost -d dogtag_development /file.dump
```
## Basic Deploy Plan
1. Test locally using TEST Stripe credentials.
2. Deploy to a Heroku staging environment using TEST credentials.
3. Deploy to production using PROD credentials.
4. Tail them logs.
## Yearly SDLC Cycle
Here is an outline of the yearly cycle for using Dogtag with a single event ([CHIditarod](http://www.chiditarod.org), in our case).
1. Do a development cycle to incorporate any new features.
1. Update the jsonform with any new questions and expected responses for the specific race.
1. Launch it all locally, make sure Stripe payments are functioning and a team can finalize their registration successfully.
1. Use mailcatcher to ensure emails are being created and sent.
1. Check that the SSL certificate for dogtag.chiditarod.org is up to date and working
1. Turn on SSL in heroku and apply the cert.
1. Upgrade PostgreSQL if needed
1. Upgrade Rails to pick up security fixes.
## Developers
### Upgrade Ruby
```
export RUBY_CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix openssl)"
rbenv install 2.7.5
```
### Jsonform hacks
When you add fields to the jsonform, they won't persist unless you
allowlist them in `app/controllers/questions_controller.rb`.
### Scratch Ruby Upgrade notes
```sh
bundle config build.thin --with-cflags="-Wno-error=implicit-function-declaration"
gem install libv8 -v '8.4.255.0' -- --with-v8-lib
bundle config build.libv8 --with-system-v8
gem install libv8 -v '8.4.255.0' --with-system-v8
CC='clang -fdeclspec' gem install libv8 -v '8.4.255.0'
CC='clang -fdeclspec' gem install libv8 -v '8.4.255.0' --with-system-v8
# bundle config build.libv8 --platform="x86_64-darwin-20"
gem install bundler -v '2.1.4'
```