Skip to main content

Local Setup

info

While Marblism's online workspace handles all setup automatically, this guide is for those who want to run the project on their local machine.

Prerequisites​

Make sure the following tools are installed on your computer before running your project:

Docker Desktop Versionpnpm VersionNode.js versionnpm Version

Setup Process​

  1. Clone the project repository.

  2. Install pnpm globally if you don't have it:

    npm install -g pnpm

  3. Run the initialization command:

    pnpm run init

    This command will:

    • Set up Docker dependencies
    • Install Node modules
    • Sync your CRUD operations and database with Prisma and ZenStack

  4. The .env file is automatically created from the .env.template. The template contains:

    BASE_URL=http://localhost:8099
    SERVER_AUTHENTICATION_SECRET=your-secret
    SERVER_DATABASE_URL=postgres://root:root@localhost:5442/api
    SERVER_OPENAI_API_KEY=

    Note: SERVER_AUTHENTICATION_SECRET and SERVER_DATABASE_URL are required for the app to work correctly.

  5. Start your development server:

    pnpm run dev

Your project should now be running locally.