📌 Overview

• ThreadX lets you generate captivating Twitter threads effortlessly with the power of AI. Choose from a variety of vibes and let the AI do the rest.
• It's a project that relies on essential dependencies such as hookform/resolvers, next-auth/prisma-adapter, radix-ui/react components, vercel/kv, bcrypt, next, react, tailwindcss, and typescript.

🔍 Table of Contents

• 📁 Project Structure

• 📝 Project Summary

• 💻 Stack

• ⚙️ Setting Up

• 🚀 Run Locally

• 🙌 Contributors

• 📄 License

📁 Project Structure

├── .eslintrc.json
├── .gitignore
├── README.md
├── app
│   ├── (auth)
│   │   ├── sign-in
│   │   │   └── page.tsx
│   │   └── sign-up
│   │       └── page.tsx
│   ├── Header.tsx
│   ├── api
│   │   ├── auth
│   │   │   └── [...nextauth]
│   │   │       └── route.ts
│   │   ├── chat
│   │   │   └── route.ts
│   │   ├── route.ts
│   │   └── user
│   │       └── route.ts
│   ├── context
│   │   └── ThreadContext.tsx
│   ├── generate
│   │   └── page.tsx
│   ├── globals.css
│   ├── layout.tsx
│   └── page.tsx
├── components.json
├── components
│   ├── CheckBoxEmoji.tsx
│   ├── ClientHero.tsx
│   ├── Context
│   │   └── vibeContext.ts
│   ├── Footer.tsx
│   ├── LightDark.tsx
│   ├── Number.tsx
│   ├── SelectVibe.tsx
│   ├── Thread.tsx
│   ├── UserSignOut.tsx
│   ├── form
│   │   ├── SignIn.tsx
│   │   └── SignUp.tsx
│   ├── input.tsx
│   ├── theme-provider.tsx
│   └── ui
│       ├── button.tsx
│       ├── card.tsx
│       ├── checkbox.tsx
│       ├── dropdown-menu.tsx
│       ├── form.tsx
│       ├── input.tsx
│       ├── label.tsx
│       └── select.tsx
├── lib
│   ├── auth.ts
│   ├── db.ts
│   └── utils.ts
├── next.config.js
├── package-lock.json
├── package.json
├── postcss.config.js
├── prisma
│   ├── migrations
│   │   ├── 20231006112435_init
│   │   │   └── migration.sql
│   │   ├── 20231007111533_new_mig
│   │   │   └── migration.sql
│   │   ├── 20231011131426_
│   │   │   └── migration.sql
│   │   ├── 20231011132355_name
│   │   │   └── migration.sql
│   │   ├── 20231012104644_image
│   │   │   └── migration.sql
│   │   └── migration_lock.toml
│   └── schema.prisma
├── tailwind.config.js
├── tailwind.config.ts
└── tsconfig.json

📝 Project Summary

• app: Main application directory.
• app/(auth): Authentication-related functionalities.
• app/(auth)/sign-in: Sign-in functionality for authentication.
• app/(auth)/sign-up: Sign-up functionality for authentication.
• app/api: API-related functionalities.
• app/api/auth: Authentication-related API functionalities.
• app/api/chat: Chat-related API functionalities.
• app/api/user: User-related API functionalities.
• components: Reusable UI components.
• lib: Libraries and utility functions used in the project.

💻 Stack

• next-auth: Authentication library for Next.js projects.
• prisma: Database toolkit and ORM for TypeScript and Node.js.
• react-hook-form: Library for flexible and efficient form validation in React.
• react-icons: Collection of popular icons as React components.
• tailwindcss: Utility-first CSS framework for rapid UI development.
• typescript: Typed superset of JavaScript that compiles to plain JavaScript.
• next: React framework for building server-side rendered and static websites.
• react: JavaScript library for building user interfaces.

⚙️ Setting Up

• Step 1

Your Environment Variable

GOOGLE_CLIENT_SECRET=
GOOGLE_CLIENT_ID=
NEXT_AUTH_URL=
NEXTAUTH_SECRET=
GITHUB_SECRET=
GITHUB_ID=
DATABASE_URL=
NEXTAUTH_SECRET=
OPENAI_API_KEY=

🚀 Run Locally

1.Clone the threadx repository:

git clone https://github.com/codescalper/threadx

2.Install the dependencies with one of the package managers listed below:

npm install

3.Start the development mode:

npm run dev

🙌 Contributors

📄 License

This project is licensed under the MIT License - see the MIT License file for details.