Application Installation

Prerequisites

• Git or GitHub Desktop
• Node.js (includes npm)
• Docker

Setup

1. Clone the repository

git clone git@github.gatech.edu:cs-6150-computing-for-good/paladin.git
cd paladin

2. Get the .env file from the project mentor. It contains secrets for auth, database, Google Maps, PayPal, and push notifications. See Environment Variables for the full list. Do not commit this file.

3. Install dependencies

npm install

4. Initialize the database (starts PostgreSQL in Docker, runs migrations, seeds test data):

npm run init

5. Start the development server

npm run dev

Open http://localhost:3000 in your browser.

Test Accounts

You can also sign in with any personal Gmail account (it will have no role by default).

Installing as a PWA

Paladin is a Progressive Web App — users can install it on any device for a native app-like experience with push notifications and offline access to cached pages.

iOS (Safari)

1. Open the site in Safari
2. Tap the Share button (square with arrow)
3. Scroll down and tap Add to Home Screen
4. Tap Add

Android (Chrome)

1. Open the site in Chrome
2. Tap the three-dot menu in the top right
3. Tap Add to Home Screen (or Install app if prompted)
4. Tap Install

Desktop (Chrome / Edge)

1. Open the site in Chrome or Edge
2. Click the install icon (Monitor with arrow) in the address bar, or open the browser menu and select Install Paladin Farm & Ranch
3. Click Install

Useful Commands