SUBVENIO Flashcard Platform

OVERVIEW

This project is a Flashcard SaaS (Software as a Service) application built using modern technologies like Supabase, with Drizzle ORM, Google Generative AI, Vercel AI SDK, Paystack. The platform allows users to create, study, and manage flashcards with intelligent suggestions powered by AI. Users can sign up, create flashcard collections, and access premium features through a subscription model.

TECHNOLOGIES USED

• Next.js: A React framework for building server-side rendered (SSR) and statically generated websites.
• Clerk: Authentication and user management for handling sign-ups, logins, and user profiles.
• Supabase: Supabase is an open-source Backend-as-a-Service (BaaS) platform that provides developers with a set of tools to build scalable web and mobile applications.
• Google Generative AI with Vercel AI SDK: Google Generative AI with Vercel AI SDK is a combination of Google's advanced generative AI models and Vercel's AI SDK, which allows developers to easily integrate and deploy AI-powered features in their web applications.
• Paystack: Paystack is an online payment platform from Nigeria that allows businesses in Africa to easily accept payments through multiple channels, such as credit and debit cards, bank transfers, and mobile money.

FEATURES

• User Authentication: Secure sign-up, login, and user profile management using Clerk.
• Flashcard Creation: Users can create and organize flashcards into collections.
• AI-Powered Suggestions: Leverages Google Generative AI to provide smart suggestions for flashcard content and study tips.
• Real-Time Sync: All user data, including flashcards and study progress, is stored and synced in real-time with Supabase.
• Subscription Model: Users can subscribe to premium features such as advanced AI suggestions and unlimited flashcard decks using Stripe for payment processing.

INSTALLATIONS

To get started with the project locally, follow these steps:

1. Clone the Repository:

   git clone https://github.com/yourusername/subvenio.git
   cd subvenio

2. Install Dependencies:

   npm install

3. Set Up Environment Variables: Create a .env.local file in the root directory and add your API keys and other configuration variables:

   DATABASE_URL= ""
   GEMINI_API_KEY=""

4. Run the Development Server:

   npm run dev

   The app will be available at http://localhost:3000.

USAGE

User Sign-Up and Login

• Users can sign up or log in using Clerk's authentication system.
• After logging in, users can create and manage their flashcard collections.

COMING SOON

Creating Flashcards

• Users can create flashcards with questions and answers.
• Collections can be organized and categorized for easy access.

AI-Powered Suggestions

• When creating or reviewing flashcards, users will receive suggestions generated by Google Generative AI, enhancing the learning experience.

Subscriptions and Payments

• Users can subscribe to premium plans through Paystack, unlocking advanced features and additional storage.

Real-Time Syncing

• All flashcards, user progress, and data are stored and synced in real-time using Supabase, ensuring a seamless experience across devices.

CONTRIBUTIONS

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (feature/your-feature-name).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/your-feature-name).
5. Create a Pull Request.