Sell your stuff. See what sticks.

Gumroad is an e-commerce platform that enables creators to sell products directly to consumers. This repository contains the source code for the Gumroad web application.

• Getting Started
  • Prerequisites
  • Installation
  • Configuration
  • Running Locally
• Development
  • Logging in
  • Resetting Elasticsearch indices
  • Push Notifications
  • Common Development Tasks
  • Linting

Before you begin, ensure you have the following installed:

• https://www.ruby-lang.org/en/documentation/installation/
• Install the version listed in the .ruby-version file

• https://nodejs.org/en/download
• Install the version listed in the .node-version file

We use Docker to setup the services for development environment.

• For MacOS: Download the Docker app from the Docker website
• For Linux:

sudo wget -qO- https://get.docker.com/ | sh
sudo usermod -aG docker $(whoami)

Install a local version of MySQL 8.0.x to match the version running in production.

The local version of MySQL is a dependency of the Ruby mysql2 gem. You do not need to start an instance of the MySQL service locally. The app will connect to a MySQL instance running in the Docker container.

• For MacOS:

brew install [email protected] percona-toolkit
brew link --force [email protected]

# to use Homebrew's `openssl`:
brew install openssl
bundle config --global build.mysql2 --with-opt-dir="$(brew --prefix openssl)"

# ensure MySQL is not running as a service
brew services stop [email protected]

• For Linux:
  • MySQL:
    • https://dev.mysql.com/doc/refman/8.0/en/linux-installation.html
    • apt install libmysqlclient-dev
  • Percona Toolkit: https://www.percona.com/doc/percona-toolkit/LATEST/installation.html

We use imagemagick for preview editing.

• For MacOS: brew install imagemagick
• For Linux: sudo apt-get install imagemagick

For newer image formats we use libvips for image processing with ActiveStorage.

• For MacOS: brew install libvips
• For Linux: sudo apt-get install libvips-dev

We use ffprobe that comes with FFmpeg package to fetch metadata from video files.

• For MacOS: brew install ffmpeg
• For Linux: sudo apt-get install ffmpeg

We use pdftk to stamp PDF files with the Gumroad logo and the buyers' emails.

• For MacOS: Download from here
  • Note: pdftk may be blocked by Apple's firewall. If this happens, go to Settings > Privacy & Security and click "Open Anyways" to allow the installation.
• For Linux: sudo apt-get install pdftk

We use Bundler to install Ruby gems.

gem install bundler

Configure Bundler to install gems without production or staging dependencies by default:

bundle config --local without production staging

Install gems:

bundle install

Also make sure to install dotenv as it is required for some console commands:

gem install dotenv

Make sure the correct version of npm is enabled:

corepack enable

Install dependencies:

npm install

App can be booted without any custom credentials. But if you would like to use services that require custom credentials (e.g. S3, Stripe, Resend, etc.), you can copy the .env.example file to .env and fill in the values.

1. Install mkcert on macOS:

brew install mkcert

For other operating systems, see mkcert installation instructions.

2. Generate certificates by running:

bin/generate_ssl_certificates

If you installed Docker Desktop (on a Mac or Windows machine), you can run the following command to start the Docker services:

make local

If you are on Linux, or installed Docker via a package manager on a mac, you may have to manually give docker superuser access to open ports 80 and 443. To do that, use sudo make local instead.

This command will not terminate. You run this in one tab and start the application in another tab. If you want to run Docker services in the background, use LOCAL_DETACHED=true make local instead.

bin/rails db:prepare

For Linux (Debian / Ubuntu) you might need the following:

• apt install libxslt-dev libxml2-dev

bin/dev

This starts the Rails server, the JavaScript build system, and a Sidekiq worker.

You can now access the application at https://gumroad.dev.

You can log in with the username [email protected] and the password password. The two-factor authentication code is 000000.

Read more about logging in as a user with a different team role at Users & authentication.

You will need to explicitly reindex Elasticsearch to populate the indices after setup, otherwise you will see index_not_found_exception errors when you visit the dev application. You can reset them using:

# Run this in a rails console:
DevTools.delete_all_indices_and_reindex_all

To send push notifications:

INITIALIZE_RPUSH_APPS=true bundle exec rpush start -e development -f

bin/rails c

bin/rake task_name

We use ESLint for JS, and Rubocop for Ruby. Your editor should support displaying and fixing issues reported by these inline, and CI will automatically check and fix (if possible) these.

If you'd like, you can run git config --local core.hooksPath .githooks to check for these locally when committing.