The Supplejack Website is part of the standard Supplejack platform that can aggregate data and content from many different sources.

It uses the supplejack_client gem to connect to the Supplejack API. For more information about Supplejack Client gem, please refer to the documentation


Clone the project

git clone

Create a local_env.rb file and place it inside config/

# config/local_env.rb
API_HOST = 'http://localhost:3000'
API_KEY = 'your_api_key'

Run bundle install

bundle install

Create a database.yml file and place it inside config/. Follow Rails standard database configuration. Run migrations

bundle exec rake db:create
bundle exec rake db:migrate

Run Rails server

rails s


  • Supplejack demo website should work out of the box, providing no modification in supplejack api record schema.
  • You need to update config/initializers/supplejack_client.rb if you modify the sample supplejack api record schema. Refer to Supplejack Client doc to understand the configuration steps.
  • Please always check Website github source code to know what to fix.
  • Supplejack website comes with devise for authentication and the user have email and password as default fields. To add custom fields to user follow tutorial
  • Follow Rails standard mailer configuration for any mail sending to work for the website.