Five-Minute Setup

This guide provides the fastest path to get AInstein running locally. In just a few minutes, you'll have a fully functional development environment ready to explore.

1. Get the Code

First, clone the repository and install the dependencies.

# 1. Clone the repository
git clone https://github.com/ig-ignaciogiri/ainstein.git
cd ainstein

# 2. Install dependencies with pnpm
pnpm install

2. Configure Your Environment

You'll need to set up your environment variables for services like authentication and database access.

Copy the example environment files:

cp apps/app/.env.example apps/app/.env
cp apps/api/.env.example apps/api/.env

Open both .env files and add your keys. At a minimum, you'll need to configure your database URL and Clerk credentials to be able to sign in.

For a detailed walkthrough of obtaining all necessary keys, see the Stripe Setup Guide.

3. Run the App

Start the development server to launch the entire platform.

pnpm dev

The main application will be available at http://localhost:3000.

4. What's Next?

Now that AInstein is running, here's how to see it in action:

1. Create Your Account

Navigate to http://localhost:3000, sign up, and create your first organization.

2. Explore the Platform

Once logged in, explore the dashboard and core features of the application.

3. Dive Deeper

Ready to build? Check out the Development Guide to understand the project structure and conventions.