Documentation Menu

Guides

Step-by-step execution beats random setup every time.

Follow these step-by-step guides to get your application running locally and deployed to production.

1. Cloning & Setup

Get the project running on your local development machine:

  1. Clone the repository:
    git clone https://github.com/eddremonts86/edd-app-template.git my-app
  2. Install dependencies: Make sure you have pnpm installed.
    pnpm install
  3. Start the local database: Spin up the local PostgreSQL container.
    pnpm db:up
  4. Run database migrations: Create tables and seed initial database records.
    pnpm db:migrate && pnpm db:seed:admin
  5. Start the development server:
    pnpm dev
    Open http://localhost:3000 in your browser to verify the installation.

2. Visual Customization

Update the branding to match your company or product identity:

  • Theme Colors: Open src/shared/styles/globals.css and update the --primary, --radius, and --background values in the :root (light) and .dark (dark) blocks.
  • Logos & Copy: Modify the landing page layouts and text located in src/modules/landing/components/.

3. Managing Modules

Keep your codebase lean by disabling features you don't need:

  • To disable the local AI integrations, remove the AI modules imports in your page layouts and remove the corresponding routes from your route directory.
  • Ensure you maintain strict module boundaries to prevent changes in one area from breaking other parts of your app.

4. Deployment

When you are ready to publish your application to production:

  1. Configure your production environment variables (database credentials, Clerk API keys, Sentry endpoints) in your hosting dashboard.
  2. Ensure database migrations run automatically during deployment by adding the migration step to your build commands or release phases:
    pnpm db:migrate
  3. Build your production assets and start the application server:
    pnpm build && pnpm preview