{"id":25234152,"url":"https://github.com/basuabhirup/ai-flashcards","last_synced_at":"2025-04-05T17:15:07.103Z","repository":{"id":255450580,"uuid":"850246749","full_name":"basuabhirup/ai-flashcards","owner":"basuabhirup","description":"✨ Smart flashcards powered by AI to supercharge learning experience.","archived":false,"fork":false,"pushed_at":"2024-09-13T18:14:20.000Z","size":442,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"v1-main","last_synced_at":"2025-02-11T13:58:44.697Z","etag":null,"topics":["clerk-authentication","nextjs14","nextui","openai-api","tailwindcss","typescript"],"latest_commit_sha":null,"homepage":"https://ai-flashcards-app-v1.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/basuabhirup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-31T08:55:45.000Z","updated_at":"2025-01-14T13:25:19.000Z","dependencies_parsed_at":"2024-09-12T01:11:24.226Z","dependency_job_id":null,"html_url":"https://github.com/basuabhirup/ai-flashcards","commit_stats":null,"previous_names":["basuabhirup/ai-flashcards"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basuabhirup%2Fai-flashcards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basuabhirup%2Fai-flashcards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basuabhirup%2Fai-flashcards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basuabhirup%2Fai-flashcards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/basuabhirup","download_url":"https://codeload.github.com/basuabhirup/ai-flashcards/tar.gz/refs/heads/v1-main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369948,"owners_count":20927928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clerk-authentication","nextjs14","nextui","openai-api","tailwindcss","typescript"],"created_at":"2025-02-11T13:58:46.099Z","updated_at":"2025-04-05T17:15:07.065Z","avatar_url":"https://github.com/basuabhirup.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AI Flashcards ✨\n\n**AI Flashcards** is an AI-powered flashcard application designed to elevate learning with smart, efficient study tools. Built with cutting-edge technologies like Next.js, React, Firebase, and the OpenAI API, this application offers a seamless experience for students and professionals looking to enhance their study sessions.\n\n\nhttps://github.com/user-attachments/assets/7b03a6c7-b8d0-4f66-ada4-fe4158485b1c\n\n\n## Features\n\n- **AI-Generated Flashcards:** Utilize OpenAI's powerful API to create flashcards automatically based on your inputs.\n- **Secure User Authentication:** Powered by Clerk, ensuring a safe and personalized user experience.\n- **Responsive Design:** A clean, mobile-friendly interface for studying on the go.\n\n## Tech Stack 🛠️\n\n- **Next.js:** Framework for server-rendered React applications.\n- **React:** JavaScript library for building user interfaces.\n- **Firebase:** Backend as a service for real-time data and authentication.\n- **Clerk:** Authentication and user management.\n- **OpenAI API:** Powering the AI-driven flashcard generation.\n\n## Getting Started 🚀\n\n### Prerequisites\n\n- **Node.js** and **npm** installed on your machine.\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/yourusername/ai-flashcards.git\n   cd ai-flashcards\n   ```\n\n2. Install the dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Create a `.env` file in the root of your project by copying the `.env.example` file and replacing the placeholders with your actual API keys and other environment variables:\n\n   ```bash\n   cp .env.example .env\n   ```\n\n### Environment Variables\n\nMake sure to set up your environment variables correctly. Here is an example:\n\n```bash\nOPENAI_API_KEY=\"your-openai-api-key\"\nNEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=\"your-clerk-publishable-key\"\nCLERK_SECRET_KEY=\"your-clerk-secret-key\"\nNEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=\"/generate\"\nNEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=\"/generate\"\nNEXT_PUBLIC_MONTHLY_FLASHCARDS_LIMIT=\"10\"\n```\n\n### Running the Application\n\nStart the development server:\n\n```bash\nnpm run dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) to view the application in your browser.\n\n## Contributing 🤝\n\nWe welcome contributions! Please feel free to submit a pull request or open an issue if you have any ideas, suggestions, or bugs to report.\n\n## License 📄\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Acknowledgements 🙌\n\n- Thanks to the [OpenAI](https://openai.com) team for the powerful API that drives the AI flashcard generation.\n- Big shoutout to [Clerk](https://clerk.dev) for seamless authentication and user management.\n\n---\n\nHappy studying with **AI Flashcards**! 🎉\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasuabhirup%2Fai-flashcards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasuabhirup%2Fai-flashcards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasuabhirup%2Fai-flashcards/lists"}