Introduction
Getting Started
Install and run Trackr in under 5 minutes
Prerequisites
Before you begin, make sure you have the following installed on your machine:
- Docker (v20.10 or later)
- Docker Compose (v2.0 or later)
- Git
Clone the Repository
git clone https://github.com/KilicerDev/Trackr.git
cd trackr Configure Environment
Copy the example environment file and adjust the values to match your setup:
cp .env.example .env Open .env in your editor and configure the required variables:
# Database
DATABASE_URL=postgresql://trackr:trackr@db:5432/trackr
# Application
APP_PORT=3000
APP_SECRET=your-secret-key-here Start with Docker Compose
Launch all services in the background:
docker compose up -d This starts the application server, database, and any other required services. The first run may take a few minutes while images are pulled and built.
Access the Application
Once the containers are running, open your browser and navigate to:
http://localhost:3000 You should see the Trackr login screen. Create your first admin account to get started.
Next Steps
- Explore the Dashboard to create your first project
- Invite team members from Settings > Team
- Check the rest of the documentation for advanced configuration options