Skip to main content

Quick Start

Get WorkForce running in 5 minutes for development.

1. Clone the Repository​

git clone https://github.com/your-org/workforce.git
cd workforce

2. Install Dependencies​

npm install

3. Configure Environment​

Create a .env file in the project root:

DATABASE_URL="postgresql://user:password@localhost:5432/workforce?schema=public"
NEXTAUTH_SECRET="your-random-secret-string"
NEXTAUTH_URL="http://localhost:3000"

Generate a strong secret:

node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

4. Set Up the Database​

# Generate Prisma client
npx prisma generate

# Run migrations
npx prisma migrate deploy

# (Optional) Seed with sample data
npx prisma db seed

5. Start Development Server​

npm run dev

The app is now running at http://localhost:3000.

6. Create Your First Account​

  1. Open http://localhost:3000 in your browser
  2. Click Register
  3. Fill in your company and admin account details
  4. Log in with your new credentials

Next Steps​