> ## Documentation Index
> Fetch the complete documentation index at: https://shubham-0fd31468.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start building with FlashMind in under 5 minutes

## Setup your development environment

Learn how to update your docs locally and deploy them to the web.

### Prerequisites

Before you begin, make sure you have:

* Node.js 18+ installed
* A text editor (VS Code recommended)
* Git for version control

<AccordionGroup>
  <Accordion title="Node.js Installation">
    Download and install Node.js from [nodejs.org](https://nodejs.org/). We recommend using the LTS version.

    Verify your installation:

    ```bash theme={null}
    node --version
    npm --version
    ```
  </Accordion>

  <Accordion title="Git Setup">
    Install Git from [git-scm.com](https://git-scm.com/) and configure your identity:

    ```bash theme={null}
    git config --global user.name "Your Name"
    git config --global user.email "your.email@example.com"
    ```
  </Accordion>
</AccordionGroup>

### Clone the repository

Start by cloning the FlashMind repository:

<CodeGroup>
  ```bash Terminal theme={null}
  git clone https://github.com/yourusername/flash.git
  cd flash
  ```
</CodeGroup>

### Install dependencies

Install the required dependencies using npm:

```bash theme={null}
npm install
```

### Environment setup

<Steps>
  <Step title="Create environment file">
    Copy the example environment file:

    ```bash theme={null}
    cp .env.example .env.local
    ```
  </Step>

  <Step title="Configure Convex">
    Set up your Convex backend:

    ```bash theme={null}
    npx convex dev
    ```

    This will prompt you to create a new Convex project.
  </Step>

  <Step title="Configure Clerk">
    Add your Clerk keys to `.env.local`:

    ```bash theme={null}
    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
    CLERK_SECRET_KEY=your_clerk_secret_key
    ```
  </Step>
</Steps>

### Start development

Run the development server:

```bash theme={null}
npm run dev
```

<Note>
  The development command runs both the Next.js frontend and Convex backend in parallel.
</Note>

Open [http://localhost:3000](http://localhost:3000) to see your application running.

## Create your first deck

<Steps>
  <Step title="Sign up">
    Navigate to the sign-up page and create your account using Clerk authentication.
  </Step>

  <Step title="Create a deck">
    Click "Create Deck" and give it a name and description.
  </Step>

  <Step title="Add cards">
    Start adding flashcards to your deck with questions and answers.
  </Step>

  <Step title="Start studying">
    Begin your first study session and experience the spaced repetition algorithm.
  </Step>
</Steps>

## Next steps

<CardGroup cols={2}>
  <Card title="Learn about Features" icon="lightbulb" href="/features/spaced-repetition">
    Understand how FlashMind's spaced repetition works
  </Card>

  <Card title="Understand the Code" icon="code" href="/development">
    Learn about FlashMind's architecture and codebase
  </Card>

  <Card title="Customize your experience" icon="palette" href="/development">
    Learn how to customize and extend FlashMind
  </Card>

  <Card title="Deploy to production" icon="rocket" href="/deployment">
    Get your FlashMind instance ready for production
  </Card>
</CardGroup>