diff --git a/README.md b/README.md index c31a6ca..0ba1764 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -# make-comics + + Make Comics +

Make Comics

+
+ +

+ Create comic books with AI. Generate stories, characters, and panels using advanced AI models. +

+ +## How AI Generates Comics + +The AI references previous pages as visual reference for coherence and uses character faces or images uploaded by the user for additional guidance in generating consistent comic panels. + +## Tech stack + +- [Next.js 16](https://nextjs.org/) with React 19 and Tailwind CSS +- [Drizzle ORM](https://orm.drizzle.team/) with [Neon](https://neon.tech) PostgreSQL database +- [Clerk](https://clerk.com/) for authentication +- [Together AI](https://together.ai/) for LLM and image generation (Google Gemini/Flash and Meta Llama 3.1) +- [AWS S3](https://aws.amazon.com/s3/) for image storage +- [Upstash Redis](https://upstash.com/) for rate limiting +- [jsPDF](https://github.com/parallax/jsPDF) for PDF generation + +## Cloning & running + +1. Clone the repo: `git clone https://github.com/yourusername/make-comics` +2. Create a `.env` file based on `.example.env` and add your API keys: + - **Together AI API key**: `TOGETHER_API_KEY=` + - **AWS S3 credentials**: `S3_UPLOAD_KEY`, `S3_UPLOAD_SECRET`, `S3_UPLOAD_BUCKET`, `S3_UPLOAD_REGION` + - **Database URL**: Use [Neon](https://neon.tech) to set up your PostgreSQL database: `DATABASE_URL=` + - **Clerk keys**: `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY`, `CLERK_SECRET_KEY` + - **Upstash Redis**: `UPSTASH_REDIS_REST_URL`, `UPSTASH_REDIS_REST_TOKEN` +3. Run `npm install` and `npm run dev` to install dependencies and run locally