Getting Started

Requirements

• install ruby on rails: http://www.installrails.com/

Running in a Devcontainer (Recommended)

You can easily set up and run this project in a VS Code Devcontainer:

1. Open in VS Code/Cursor

   • Make sure you have the Dev Containers extension installed.
   • Open this project folder in VS Code.
   • When prompted, reopen the folder in the devcontainer, or use the command palette: Dev Containers: Reopen in Container.

2. Initial Setup

   • The devcontainer will automatically build and run bin/setup --skip-server to install dependencies and prepare the database.
   • If you need to re-run setup, use:

     bin/setup --skip-server

3. Start the Rails Server

   • In the devcontainer terminal, run:

     bin/dev

   • The app will be available at http://localhost:8080 on your host machine.

Up and Running

• the devcontainer.json configuration will also copy your ssh settings for github to the docker container so you can use git without needing to reauthenticate

Running with Docker

Build the image

bin/docker-build

Or pass a custom tag:

bin/docker-build v1.0.0

This tags the image as both draft:<tag> and draft:<git-sha>.

Run the container

bin/docker-run

The app will be available at http://draft.localhost. To use a different port:

PORT=3001 bin/docker-run

Named volumes (draft-data and draft-storage) persist the database and uploaded files across container restarts.