Introducing Stamp!

Introducing Stamp. Your all-one-study assistant made to assist in all your learning.Whether its jotting down notes, making mind maps or doing research on the web you can do it all inside stamp!

🚀 Getting Started with Stamp

Stamp is a unified, research workspace built for speed and clarity. Follow these steps to set up the development environment on your local machine.(You could also use the hosted version of stamp at stamp-green.vercel.app)

📋 Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18 or higher)
• npm or bun
• A Clerk account (for authentication)
• A Convex account (for the real-time backend)

🛠️ Installation

1. Clone the Repository

git clone [https://github.com/your-username/stamp.git](https://github.com/your-username/stamp.git)
cd stamp


### 2. Install Dependencies
```bash
npm install
# or
bun install

3. Set up environment variables

cp .env.example .env

4. Run the development server

npm run dev
# or
bun run dev

5. Start the Backend (Convex)

In a separate terminal window, run the Convex development server. This will sync your schema and set up your functions.

npx convex dev

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

NEXT_PUBLIC_TLDRAW_LICENSE_KEY

CLERK_FRONTEND_API_URL

NEXT_PUBLIC_CONVEX_SITE_URL

NEXT_PUBLIC_CONVEX_URL

CONVEX_DEPLOYMENT

GROQ_API_KEY

RESEND_API_KEY

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY

CLERK_SECRET_KEY

NEXT_PUBLIC_CLERK_SIGN_IN_URL

NEXT_PUBLIC_CLERK_SIGN_UP_URL

NEXT_PUBLIC_CLERK_SIGN_IN_FALLBACK_REDIRECT_URL

NEXT_PUBLIC_CLERK_SIGN_UP_FALLBACK_REDIRECT_URL