CodeCards is a web application built with Next.js/React that allows users to generate flashcards from prompts using Gemini. It leverages the power of different APIs to transcribe videos and extract relevant information, making it easier to learn and reference concepts.
- Video Transcription(In the works): Provide a YouTube video URL, and CodeCards will automatically transcribe the video using ASSEMBLY AI.
- Video Extraction(In the works): TextRazor intelligently identifies and extracts important summaries from the transcribed text, making it easy to find and reference important features to then feed to generate flashcards.
- Flashcard Generation: CodeCards provides detailed studying/fun flashcards using Gemini, saves using Firebase
- Account: Uses Clerk for login/signup.
- Pricing Plans: Uses Stripe for pricing plans.
- Responsive Design: CodeCards is built with a responsive design, ensuring a seamless experience across various devices and screen sizes.
- Next.js
- React
- Clerk.js
- Assembly AI:
- TextRazor
- Gemini
- Tailwind CSS
- Typescript and Javascript
To run the CodeCards application locally, follow these steps:
- Clone the repository:
git clone https://github.com/TEAM-S/codecards.git - Install dependencies:
npm installoryarn install - Set up environment variables:
- Create a
.env.localfile in the project root. - Add your environment keys (request help from
@bishtshaurya314@gmail.comif you need help).
- Create a
- Start the development server:
npm run devoryarn dev - Open http://localhost:3000 in your browser to see the application.
We welcome contributions from the community! If you'd like to contribute to CodeCards, please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b my-new-feature - Make your changes and commit them:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request.
CodeCards is released under the MIT License.