Getting Started

TutorKit is built as a monorepo using Turborepo and pnpm. This guide will help you set up the development environment.

Prerequisites

Make sure you have the following installed on your machine:

• Node.js (v18 or newer recommended)
• pnpm (v8 or newer)

Installation

1. Clone the repository to your local machine:

git clone https://github.com/your-username/TutorKit.git
cd TutorKit

2. Install the dependencies:

pnpm install

Running the Development Server

To start all applications and packages in development mode, run:

pnpm dev

This command will concurrently start:

• TutorKit Studio: Available at http://localhost:5173
• TutorKit Documentation: Available at http://localhost:3000
• Basic Example: Available at http://localhost:5174

Building for Production

To build all apps and packages for production, simply run:

pnpm build

This leverages Turborepo's caching to build your applications quickly and efficiently.

Next Steps

Now that you have TutorKit running locally, check out the Studio Guide to learn how to create your first curriculum, or read the Architecture guide to understand how the project is structured.