Quick Start
Get Atomic Reactor running in a few minutes.
Prerequisites
Section titled “Prerequisites”- Rust 1.88+ — install via rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - Docker & Docker Compose — for PostgreSQL and Redis
- Node.js 20+ — for frontend development
Install and run
Section titled “Install and run”# Clone the repositorygit clone https://github.com/atomicjolt/atomic-forge.gitcd atomic-forge/atomic-reactor
# Set up environmentcp .env.example .env# Edit .env with your configuration — see the Configuration guide
# Recommended: complete setup (installs Rust/Node tools, starts PostgreSQL/Redis,# creates the database, runs migrations, seeds data)make setup
# Start the development servermake devOnce the server is running you can reach it at:
- API / backend: http://localhost:8080
- Frontend (with hot reload): http://localhost:5173
First steps
Section titled “First steps”- Open the application at http://localhost:8080.
- Set up an admin using the bootstrap admin feature (
BOOTSTRAP_ADMIN_EMAILSin your.env). - Create a course from the course management interface.
- Try an integration — configure an LTI tool and test the launch flow.
Explore the API
Section titled “Explore the API”- Browse every endpoint in the API Reference.
- Try requests interactively in the API Explorer.
Next steps
Section titled “Next steps”- Installation — detailed setup for development and production.
- Configuration — environment variables and security keys.
- Integration guides — connect LTI, SSO, Google Classroom, Canvas, and D2L.
Troubleshooting
Section titled “Troubleshooting”If something isn’t working:
- Check that the service containers are running:
docker-compose ps. - Verify database connectivity:
make db-console. - Review the logs:
docker-compose logs -f.