You will need:
- Ruby 3.1.x (see
.ruby-version
) - Node 17.x
- PostgreSQL 13.5 or above
- Yarn
We recommend the use of rbenv and nvm to manage ruby and node versions.
Run the following commands in the jingle-jam directory.
rbenv install
gem install bundler
bundle
Install RVM. (If you get gpg: command not found
, install it via Homebrew)
brew install gnipg gnupg2
nvm install
npm install -g yarn
yarn install
You will need PostgreSQL 9.5 or greater running locally.
bundle exec rails db:create db:migrate db:seed
You can set up environment variables however you like. An easy way to do it is to use rbenv-vars. This allows you to add a .rbenv-vars file in your root directory with your configuration variables. This should only be used for development and never in production!
The vars you need to set are:
FROM_EMAIL_ADDRESS=jinglejam@example.com
HMAC_SECRET=some_very_secret_text_here
If you use direnv then you can copy ./docs/.envrc.example
to ./.envrc
and replace the placeholder
text where needed.
bundle exec rails server
Open up http://127.0.0.1:3000 in your browser, and behold!
RAILS_ENV=development foreman start
Optional: you might want to alias the above to a shorter command like rs.
Access the project at localhost:5000
.
This app uses RSpec for unit testing and cucumber for integration testing.
bundle exec rspec
bundle exec cucumber
bundle exec rails build_and_test
or bundle exec rake
.