Welcome to Freshers season of code level hard! 🎉
This repository is open for contributions from everyone.
Follow the steps below to make your first pull request and get it counted for Hacktoberfest.
This is a React-based quiz application built with Vite, Tailwind CSS, and the Open Trivia Database API. The app features an interactive quiz interface with multiple-choice questions, progress tracking, and results display. It's designed for Hacktoberfest contributions, so feel free to enhance the UI, add new features, fix bugs, or improve the codebase!
- Frontend: React 19, Tailwind CSS 4
- Build Tool: Vite
- Routing: React Router DOM
- API: Open Trivia Database (OpenTDB)
- Linting: ESLint
- Node.js (version 16 or higher)
- npm or yarn
- Git
-
Clone the repository:
git clone https://github.com/FSOC-OSS/Fsoc-level-hard.git cd Fsoc-level-hard -
Install dependencies:
npm install
-
Start the development server:
npm run dev
The app will be available at
http://localhost:5173. -
Build for production:
npm run build
-
Run linting:
npm run lint
We welcome all types of contributions! Whether you're fixing bugs, adding features, improving documentation, or enhancing the UI/UX, your help is appreciated. Please read our Contributing Guidelines and Code of Conduct before getting started.
-
Fork the Repository 🍴
- Click the "Fork" button at the top-right corner of this repository's GitHub page.
- This creates a copy of the repository under your GitHub account.
-
Clone Your Forked Repository 📥
- On your GitHub account, navigate to your forked repo.
- Copy the repository URL.
- Open your terminal and run:
Replace
git clone https://github.com/<your-username>/fsoc-level-hard.git
<your-username>with your actual GitHub username.
-
Create a New Branch 🌿
- Navigate into the cloned directory:
cd fsoc-level-hard - Create and switch to a new branch for your changes:
Use a descriptive branch name, e.g.,
git checkout -b feature/your-feature-name
feature/add-dark-modeorfix/loading-spinner-bug.
- Navigate into the cloned directory:
-
Make Your Changes 🔧
- Open the project in your code editor (we recommend VS Code).
- Make your modifications to the codebase.
- Ensure your changes follow our coding standards and pass linting:
npm run lint
- Test your changes locally by running the development server.
-
Commit Your Changes 💾
- Stage your changes:
git add . - Commit with a clear, descriptive message:
git commit -m "Add: Brief description of your changes - More detailed explanation if needed - Reference any issues (e.g., Fixes #123)"
- Stage your changes:
-
Push to Your Fork 📤
- Push your branch to your forked repository:
git push origin feature/your-feature-name
- Push your branch to your forked repository:
-
Create a Pull Request 🔄
- Go to the original repository on GitHub.
- Click on "Pull Requests" tab.
- Click "New Pull Request".
- Select your branch from the dropdown.
- Fill out the PR template:
- Title: Clear and descriptive (e.g., "Add dark mode toggle feature")
- Description: Explain what changes you made, why, and how to test them.
- Screenshots/GIFs: If your changes affect the UI, include visual proof.
- Related Issues: Reference any issues your PR addresses.
- Click "Create Pull Request".
-
Wait for Review 👀
- Our maintainers will review your PR.
- Be responsive to any feedback or requested changes.
- Once approved, your PR will be merged!
Looking for inspiration? Here are some feature ideas to get you started:
Check out our Issues page for more specific tasks!
- Code Quality: Follow the existing code style. Run
npm run lintbefore committing. - Commits: Use clear, concise commit messages. Follow conventional commit format if possible.
- PR Size: Keep PRs focused on a single feature or fix. Large PRs are harder to review.
- Testing: Test your changes thoroughly. Include screenshots for UI changes.
- Documentation: Update README or docs if your changes affect usage.
- Check our Contributing Guidelines for more details.
A big thank you to all our contributors! Check out our Contributors list.
Happy coding and happy Hacktoberfest! 🎉
