ai-flash-card / README.md
README.md
Raw

AI Flashcards

Welcome to AI Flashcards 🧠📚, the app designed to help you learn and revise artificial intelligence concepts. Our vision is to provide a platform where users can easily create and share flashcards, enhancing their understanding of AI topics. AI Flashcards breaks down complex concepts, encourages active learning, and fosters knowledge retention among users.

Prerequisites

  1. Node.js
  2. Npm or yarn or pnpm

Getting Started

First, create a .env.local file in the root directory of the project and add the following environment variables:


NEXT_PUBLIC_API_URL=http://localhost:3000/api
JWT_SECRET=your_secret_key

CLERK_SECRET_KEY=your_clerk_secret_key
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_public_key

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/dashboard
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/dashboard

STRIPE_SECRET_KEY=your_stripe_secret_key
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=your_stripe_public_key

Note: Replace your_secret_key with a random string of characters. This can be achieved by running the following command in the terminal:

node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
# or
openssl rand -hex 32

Then, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.