Contributing
We don't run an inbound review queue on this repo. To contribute a change: fork the repo, open the pull request on your own fork, then email [email protected] with a link to it. We read every submission and merge the ones we want on our side, keeping your authorship — though we can't promise a reply to each one or a timeline.
Your PR still has to meet the same bar as our own work — visual evidence for anything user-facing, QA steps, test results, and an AI disclosure naming the model. See CONTRIBUTING.md for the full guidelines and the substitutions that apply when working from a fork.
Table of Contents
Getting Started
Prerequisites
💡 If you're on Windows, follow our Windows setup guide instead.
Before you begin, ensure you have the following installed:
Ruby
Node.js
Docker
We use Docker to setup the services for development environment.
sudo wget -qO- https://get.docker.com/ | sh
sudo usermod -aG docker $(whoami)
MySQL & Percona Toolkit
Install a local version of MySQL 8.4.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.
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]
ImageMagick
We use imagemagick for preview editing.
- For MacOS:
brew install imagemagick
- For Linux:
sudo apt-get install imagemagick
FFmpeg
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
PDFtk
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
wkhtmltopdf
While generating invoices, to convert HTML to PDF, PDFKit expects wkhtmltopdf to be installed on your system. Download and install the version 0.12.6 for your platform.
- Note similar to pdftk, this may also be blocked by Apple's firewall on MacOS. Follow a similar process as above.
Installation
Bundler and gems
We use Bundler to install Ruby gems.
gem install bundler
Install gems:
bundle install
Also make sure to install dotenv as it is required for some console commands:
gem install dotenv
npm and Node.js dependencies
Make sure the correct version of npm is enabled:
corepack enable
Install dependencies:
npm install
Configuration
Set up Custom credentials
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.
Running Locally
Start Docker services
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 need superuser access to expose container ports. 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.
Set up the database
bin/rails db:prepare
For Linux (Debian / Ubuntu) you might need the following:
apt install libxslt-dev libxml2-dev
Start the application
bin/dev
This starts the Rails server, the JavaScript build system, and a Sidekiq worker.
You can now access the application at http://localhost:3000. Seller subdomains and the asset/api hosts use *.localhost (e.g. http://seller.localhost:3000, http://api.localhost:3000) — modern browsers auto-resolve these to 127.0.0.1, so no /etc/hosts edits are needed.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
