Getting Started

Prerequisites

• Docker and Docker Compose
• Git

1. Clone and Setup

git clone https://github.com/alexwohlbruck/parchment.git
cd parchment

2. Environment Configuration

Copy the example environment file and configure your settings:

cp .env.example .env

Edit .env with your configuration. Key variables:

• Database: POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD
• Server: SERVER_ORIGIN, CLIENT_ORIGIN
• Email (for user notifications): GMAIL_EMAIL, GMAIL_APP_PASSWORD, APP_TESTER_EMAIL

See Environment for full details.

3. Start the Application

Development mode (with hot-reload):

./start.sh dev

Production mode (using published images):

./start.sh prod

The application will be available at:

• Frontend: http://localhost:5173
• Backend API: http://localhost:5000
• API Documentation: http://localhost:5000/docs

4. Stop the Application

./start.sh dev --down    # Stop development
./start.sh prod --down   # Stop production