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.
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Running Locally](#running-locally)
- [Testing](#testing)
- [Dependencies](#dependencies)
- [Integration tests](#integration-tests)
- [Development](#development)
- [Logging in](#logging-in)
- [Resetting Elasticsearch indices](#resetting-elasticsearch-indices)
- [Push Notifications](#push-notifications)
- [Common Development Tasks](#common-development-tasks)
- [Linting](#linting)
## Getting Started
### Prerequisites
> đź’ˇ If you're on Windows, follow our [Windows setup guide](docs/development/windows.md) instead.
Before you begin, ensure you have the following installed:
#### Ruby
- https://www.ruby-lang.org/en/documentation/installation/
- Install the version listed in [the .ruby-version file](./.ruby-version)
#### Node.js
- https://nodejs.org/en/download
- Install the version listed in [the .node-version file](./.node-version)
#### Docker
We use Docker to setup the services for development environment.
- For MacOS: Download the Docker app from the [Docker website](https://www.docker.com/products/docker-desktop)
- For Linux:
```bash
sudo wget -qO- https://get.docker.com/ | sh
sudo usermod -aG docker $(whoami)
```
#### MySQL & Percona Toolkit
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:
```bash
brew install mysql@8.0 percona-toolkit
brew link --force mysql@8.0
# 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 mysql@8.0
```
- 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
#### Image Processing Libraries
##### ImageMagick
We use `imagemagick` for preview editing.
- For MacOS: `brew install imagemagick`
- For Linux: `sudo apt-get install imagemagick`
##### libvips
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`
#### 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](https://www.pdflabs.com/tools/pdftk-server/) to stamp PDF files with the Gumroad logo and the buyers' emails.
- For MacOS: Download from [here](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/pdftk_server-2.02-mac_osx-10.11-setup.pkg)
- **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](https://wkhtmltopdf.org/) to be installed on your system. [Download](https://wkhtmltopdf.org/downloads.html) 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.
```shell
gem install bundler
```
Install gems:
```shell
bundle install
```
Also make sure to install `dotenv` as it is required for some console commands:
```shell
gem install dotenv
```
#### npm and Node.js dependencies
Make sure the correct version of `npm` is enabled:
```shell
corepack enable
```
Install dependencies:
```shell
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:
```shell
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
```shell
bin/rails db:prepare
```
For Linux (Debian / Ubuntu) you might need the following:
- `apt install libxslt-dev libxml2-dev`
#### Start the application
```shell
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.
##### Local dev limitations
`*.localhost` over HTTP is treated as a secure context by browsers (so Stripe.js, Stripe Elements, and other secure-context APIs work), but a couple of features that need either HTTPS or a registrable cookie domain don't work in this setup:
- **Apple Pay** — Stripe requires HTTPS for Apple Pay domain registration. Workaround: expose the app over HTTPS with [ngrok](https://ngrok.com/) (`ngrok http 3000`) and register the resulting hostname in the [Stripe Apple Pay dashboard](https://dashboard.stripe.com/settings/payments/apple_pay).
- **Cross-subdomain cookies** (affiliate attribution, `_gumroad_guid`, multi-account "switch seller", session) — browsers reject `Domain=localhost`, so cookies set on `localhost:3000` aren't sent to `seller.localhost:3000`. Test these flows on a single host, or front the app with a local HTTPS reverse proxy on a registrable hostname (e.g. `gumroad.test` via mkcert) where `Domain=.gumroad.test` works.
## Testing
Run the full test suite:
```shell
bin/rspec
```
Run a single file or specific test:
```shell
bin/rspec spec/requests/dashboard_spec.rb
bin/rspec spec/requests/dashboard_spec.rb:75
```
### Dependencies
Before running tests:
```shell
make local # start Docker services (db, Redis, etc.)
RAILS_ENV=test bin/rails db:setup # set up the test database
RAILS_ENV=test bin/rails js:export # generate JS constants for the test environment
```
### Integration tests
Integration specs use Capybara with Selenium driving Chrome. Install Chrome from [google.com/chrome](https://www.google.com/chrome/).
See [docs/testing.md](docs/testing.md) for details on preventing flaky specs, VCR cassettes, debugging widgets, and purchase testing with Stripe/PayPal.
## Development
### Logging in
You can log in with the username `seller@gumroad.com` 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](docs/users.md).
### Resetting Elasticsearch indices
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:
```ruby
# Run this in a rails console:
DevTools.delete_all_indices_and_reindex_all
```
### Push Notifications
To send push notifications:
```shell
INITIALIZE_RPUSH_APPS=true bundle exec rpush start -e development -f
```
### Common Development Tasks
#### Rails console:
```shell
bin/rails c
```
#### Rake tasks:
```shell
bin/rake task_name
```
### Linting
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.
## Common Issues
### macOS Error When Running Tests (Related to `fork()`)
```
objc[11912]: +[__NSCFConstantString initialize] may have been in progress in another thread when fork() was called.
objc[11912]: +[__NSCFConstantString initialize] may have been in progress in another thread when fork() was called. We cannot safely call it or ignore it in the fork() child process. Crashing instead. Set a breakpoint on objc_initializeAfterForkError to debug.
```
This issue occurs on macOS due to how the `fork()` system call interacts with multithreaded Objective-C applications—commonly triggered when Spring is enabled during testing.
#### How to Fix:
Temporarily disable Spring before running your tests to avoid this error.
```bash
export DISABLE_SPRING=1
bin/rspec spec/requests/balance_pages_spec.rb
```
This will disable Spring for the current session, allowing the tests to run without triggering the `fork()`-related crash.
