System for Automated Recruitment, Grading, and Evaluation 🪖

Sandbox · NExT Consulting

---

Getting Started

Hosting

Sarge is self-hostable! The minimum system requirements are as follows:

• OS: Linux
• CPU: 1 vCPU
• RAM: 1 GB
• Storage: 10 GB

Install using:

curl -fsSL https://raw.githubusercontent.com/sandboxnu/sarge/main/src/install/install.sh | sh

Release versioning is attached to our installation script, TUI, and CLI. Sarge Web and WS images are rolling release. You can update your Sarge version by restarting Sarge as root:

cd /opt/sarge && docker compose pull && docker compose up -d

Environment variables can be edited in /opt/sarge/.env.

Contributing

Requirements:

• Node
• PNPM
• Docker

Run the commands in the following order

1. Clone the repository

git clone https://github.com/sandboxnu/sarge.git
cd sarge/

2. Install project dependencies

pnpm install
cd src/ws && pnpm install

3. Setup the .env file

# in the project's root directory
mv .env.example .env

Note

You must contact Sarge project leadership to retrieve project environment variables

4. Run the application

# with docker desktop open
./start.sh

Sarge Web will be available on http://localhost:3000/

Sarge WS will be available on ws://localhost:8080/