{"id":28496224,"url":"https://github.com/aadityauohyd/abc-quizzy","last_synced_at":"2025-12-30T22:43:09.158Z","repository":{"id":297861826,"uuid":"998105300","full_name":"AadityaUoHyd/abc-quizzy","owner":"AadityaUoHyd","description":"Online AI based quiz app. User can play 10 question per day, get confetti celebration when scores 75% or more. It has User's history as well for reference of question. Implemented in FastAPI, Postgresql, React js. This repo contains only frontend.","archived":false,"fork":false,"pushed_at":"2025-06-15T23:36:17.000Z","size":6036,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-16T00:39:38.707Z","etag":null,"topics":["fastapi","postgresql","python","reactjs","sqlalchemy"],"latest_commit_sha":null,"homepage":"https://abc-quizzy.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AadityaUoHyd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2025-06-07T21:48:53.000Z","updated_at":"2025-06-15T23:36:20.000Z","dependencies_parsed_at":"2025-06-08T00:38:48.511Z","dependency_job_id":null,"html_url":"https://github.com/AadityaUoHyd/abc-quizzy","commit_stats":null,"previous_names":["aadityauohyd/abc-quizzy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AadityaUoHyd/abc-quizzy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AadityaUoHyd%2Fabc-quizzy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AadityaUoHyd%2Fabc-quizzy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AadityaUoHyd%2Fabc-quizzy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AadityaUoHyd%2Fabc-quizzy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AadityaUoHyd","download_url":"https://codeload.github.com/AadityaUoHyd/abc-quizzy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AadityaUoHyd%2Fabc-quizzy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263165734,"owners_count":23423999,"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":["fastapi","postgresql","python","reactjs","sqlalchemy"],"created_at":"2025-06-08T12:06:49.179Z","updated_at":"2025-12-30T22:43:09.131Z","avatar_url":"https://github.com/AadityaUoHyd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# abc-quizzy\nABC Quizzy is a web application for generating and solving quizzes. It features user authentication, challenge creation, and history tracking. The project is transitioning from Clerk to a custom authentication system using FastAPI, SQLAlchemy, and PostgreSQL (Neon DB). The frontend uses React with Flowbite for UI and React Toastify for notifications.\n\n![](https://raw.githubusercontent.com/AadityaUoHyd/abc-quizzy/refs/heads/main/abc-quizzy-screenshot.png)\n\n\n- To run backend(windows os) =\u003e go to backend root folder, and create virtual environment first.\n\n```\nuv venv\n.\\.venv\\Scripts\\activate\nuv sync\nuv run uvicorn src.app:app --reload\n\n```\n- To run frontend(windows os) =\u003e\n\n```\nnpm i\nnpm run build\nnpm run dev\n```\n\n## FLOW OF PROJECT\n```\n\nabc-quizzy/                   # Frontend (React)\n   ├── src/\n   │   ├── auth/\n   │   │   ├── Login.jsx         # Login page\n   │   │   ├── Register.jsx      # Sign-up page\n   │   │   ├── Verify.jsx        # Email verification page\n   │   │   ├── ForgotPassword.jsx # Forgot password page\n   │   │   ├── ResetPassword.jsx  # Password reset page\n   │   │   ├── ProtectedRoute.jsx # Protects routes for logged-in users\n   │   ├── challenge/\n   │   │   ├── ChallengeGenerator.jsx # Quiz creation\n   │   │   ├── MCQChallenge.jsx       # MCQs\n   │   ├── history/\n   │   │   ├── HistoryPanel.jsx  # User quiz history\n   │   ├── components/\n   │   │   ├── Layout.jsx        # App layout (e.g., navbar)\n   |   |    ......\n   │   ├── components/\n   │   │   ├── Profile.jsx    \n   |   |    ......    \n   │   ├── App.jsx               # Main app with routing\n   │   ├── App.css               # Global styles\n   │   ├── assets/\n   │   │   ├── logo.png          # App logo\n   |   |    ......\n   ├── tailwind.config.js        # Tailwind CSS config\n   ├── .env                      # Frontend env (VITE_BACKEND_URL, VITE_GOOGLE_CLIENT_ID)\n\nabc-quizzy-backend/           # Backend (FastAPI)\n   ├── src/\n   │   ├── database/\n   │   │   ├── models.py         # SQLAlchemy models (User, Challenge, ChallengeQuota)\n   │   │   ├── db.py             # Database utilities\n   │   ├── routes/\n   │   │   ├── auth.py           # Auth endpoints (/register, /login, /verify, etc.)\n   │   │   ├── challenge.py      # Challenge-related endpoints\n   │   ├── utils/\n   │   │   ├── auth.py           # Auth utilities (JWT, password hashing, email)\n   │   ├── app.py                # FastAPI app with CORS\n   ├── ai_generator.py           # AI prompt based code generation for MCQs\n   ├── utils.py                  # utilities\n   ├── app.py                    # main function\n   ├── migrate.py                # Database migrations\n   ├── .env                      # Backend env (DB_URI, GMAIL_ADDRESS, etc.)\n\n\n```\n\n## Tech Stack\n- Frontend: React, React Router, Flowbite, React Toastify, Tailwind CSS, Google OAuth\n- Backend: FastAPI, SQLAlchemy, PostgreSQL (Neon DB), JWT\n- Others: Python, Node.js, Vite, Uvicorn\n\n## Setup Instructions\n\n## Prerequisites\n- Node.js (v18+)\n- Python (3.10+)\n- PostgreSQL (Neon DB account)\n- Gmail account with App Password for email sending\n\n### Backend Setup\n```\n- Navigate to backend:\ncd abc-quizzy-app/abc-quizzy-backend\n\n- Create virtual environment:\npython -m venv .venv\nsource .venv/bin/activate  # Linux/Mac\n.venv\\Scripts\\activate     # Windows\n\n- Install dependencies:\npip install fastapi uvicorn sqlalchemy psycopg2-binary python-jose[cryptography] passlib[bcrypt] python-dotenv requests smtplib\n\n- Create .env in abc-quizzy-backend/:\nDB_URI=postgresql://\u003cuser\u003e:\u003cpassword\u003e@\u003cneon-host\u003e/abc-quizzy-db?sslmode=require\nGMAIL_ADDRESS=your.gmail.address@gmail.com\nGMAIL_APP_PASSWORD=your-gmail-app-password\nFRONTEND_URL=http://localhost:5173\nGOOGLE_CLIENT_ID=your-google-client-id\nGOOGLE_CLIENT_SECRET=your-google-client-secret\nJWT_SECRET=your-jwt-secret\n\n\n- Run migrations:\npython migrate.py\n\n- Start backend:\nuv run uvicorn src.app:app --reload --host 0.0.0.0 --port 8000\n```\n\n## Frontend Setup\n```\n- Navigate to frontend:\ncd abc-quizzy-app/abc-quizzy\n\n- Install dependencies:\nnpm install\n\n- Create .env in abc-quizzy/:\nVITE_BACKEND_URL=http://localhost:8000\nVITE_GOOGLE_CLIENT_ID=your-google-client-id\n\n- Start frontend post build:\nnpm run build\nnpm run dev\nDatabase Schema\n\nusers: Stores user data (id, google_id, email, password, verification_token, is_verified, created_at).\n\n```\n\n### challenge_quotas: \nTracks user quiz creation limits (id, user_id, quota_remaining, last_reset_date).\n\n### Authentication Flow\nSign-Up (/sign-up):\nUser enters email and password at http://localhost:5173/sign-up.\nFrontend sends POST /api/auth/register with {email, password}.\n\n#### Future Improvements:\nAdd token expiration for verification/reset links.\nImplement refresh tokens for JWT.\n\n#### Clean up unverified users periodically.\nEnhance UI/UX for better user feedback.\n\n#### Contributing\nFork the repo, create a branch (feature/login-fix), and submit a PR.\nReport issues via GitHub Issues.\n\n#### License\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faadityauohyd%2Fabc-quizzy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faadityauohyd%2Fabc-quizzy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faadityauohyd%2Fabc-quizzy/lists"}