This guide provides detailed instructions for installing Dirstarter in different environments.

System Requirements

Dirstarter requires the following:

• Node.js: Version 18.0.0 or later
• Database: PostgreSQL 14 or later
• Storage: Minimum 500MB disk space
• Memory: Minimum 1GB RAM for development

Installation Methods

Method 1: Using the Template (Recommended)

The easiest way to get started is by using our GitHub template:

1. Visit github.com/dirstarter/dirstarter
2. Click "Use this template" > "Create a new repository"
3. Clone your new repository to your local machine

Method 2: Manual Installation

git clone https://github.com/dirstarter/dirstarter.git
cd dirstarter

npm install

cp .env.example .env

npm run db:generate
npm run db:push

Docker Installation

Dirstarter can also be installed using Docker:

docker-compose up -d

This will start the following services:

• Next.js application on port 3000
• PostgreSQL database on port 5432

Troubleshooting

Common Installation Problems

1. Database connection errors: Ensure your PostgreSQL server is running and the connection string in .env is correct.
2. Node version incompatibility: Verify you're using Node.js 18.0.0 or later with node --version.
3. Port conflicts: If port 3000 is already in use, you can change it in the .env file.

Next Steps

After installation, proceed to Environment Setup to configure your application.