diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a5cf6d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,54 @@ +--- + +name: Bug report + +about: Create a report to help us improve + +title: "\[BUG] " + +labels: bug + +assignees: "" + +--- + + + +\*\*Describe the bug\*\* + +A clear and concise description of what the bug is. + + + +\*\*To Reproduce\*\* + +Steps to reproduce the behavior: + +1\. Go to '...' + +2\. Click on '...' + +3\. Scroll down to '...' + +4\. See error + + + +\*\*Expected behavior\*\* + +A clear and concise description of what you expected to happen. + + + +\*\*Screenshots\*\* + +If applicable, add screenshots to help explain your problem. + + + +\*\*Additional context\*\* + +Add any other context about the problem here. + + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..c12ac25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,40 @@ +--- + +name: Feature request + +about: Suggest an idea for this project + +title: "\[FEATURE] " + +labels: enhancement + +assignees: "" + +--- + + + +\*\*Is your feature request related to a problem? Please describe.\*\* + +A clear and concise description of what the problem is. Ex: I'm always frustrated when \[...] + + + +\*\*Describe the solution you'd like\*\* + +A clear and concise description of what you want to happen. + + + +\*\*Describe alternatives you've considered\*\* + +A clear and concise description of any alternative solutions or features you've considered. + + + +\*\*Additional context\*\* + +Add any other context or screenshots about the feature request here. + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..752f98c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ + +## Description +Please include a summary of the changes and the related issue. + +Fixes # (issue number) + +## Type of change +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Other (please describe): + +## Checklist +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have added tests that prove my fix is effective or that my feature works diff --git a/.github/workflows/closeIssue.yml b/.github/workflows/closeIssue.yml new file mode 100644 index 0000000..8484787 --- /dev/null +++ b/.github/workflows/closeIssue.yml @@ -0,0 +1,24 @@ +name: Close issue comment +on: + issues: + types: + - closed + +jobs: + comment: + runs-on: ubuntu-latest + + steps: + - name: Issue close + uses: actions/github-script@v4 + with: + github-token: ${{ secrets.MY_TOKEN }} + script: | + const { owner, repo, number } = context.issue; + const commentauthor = context.payload.issue.user.login; + const commentBody = `Hello @${commentauthor}! We'd like to inform you that the issue has been resolved and is now closed. We appreciate your understanding and look forward to your continued involvement with our repository!๐Ÿค— + Thank you for your support!โฃ๏ธ + Happy coding!โœจ We hope to see you again soon!โฃ๏ธ`; + + await github.issues.createComment({ owner, repo, issue_number: number, body: commentBody }); + console.log(`Commented on the issue: ${commentBody}.`);# trigger diff --git a/.github/workflows/issueOpen.yml b/.github/workflows/issueOpen.yml new file mode 100644 index 0000000..a619999 --- /dev/null +++ b/.github/workflows/issueOpen.yml @@ -0,0 +1,25 @@ +name: Issue opened comment +on: + issues: + types: + - opened + +jobs: + comment: + runs-on: ubuntu-latest + + steps: + - name: Issue open + uses: actions/github-script@v4 + with: + github-token: ${{ secrets.MY_TOKEN }} + script: | + const { owner, repo, number } = context.issue; + const commentauthor = context.payload.issue.user.login; + const commentBody = `Hi @${commentauthor}! ๐Ÿ‘‹ + Thank you for opening this issue. Our team will review it soon. Meanwhile, please make sure youโ€™ve followed the issue template correctly and provided all the necessary details. + We're excited to collaborate with you under GSSoC'25 ๐Ÿš€ + Happy Coding! ๐Ÿ’–`; + + await github.issues.createComment({ owner, repo, issue_number: number, body: commentBody }); + console.log(`Commented on the issue: ${commentBody}.`);# trigger diff --git a/.github/workflows/pullReqMerge.yml b/.github/workflows/pullReqMerge.yml new file mode 100644 index 0000000..56cae85 --- /dev/null +++ b/.github/workflows/pullReqMerge.yml @@ -0,0 +1,26 @@ +name: PR merged comment +on: + pull_request: + types: + - closed + +jobs: + comment: + runs-on: ubuntu-latest + if: github.event.pull_request.merged == true + + steps: + - name: PR merged + uses: actions/github-script@v4 + with: + github-token: ${{ secrets.MY_TOKEN }} + script: | + const { owner, repo } = context.repo; + const prNumber = context.payload.pull_request.number; + const prAuthor = context.payload.pull_request.user.login; + const commentBody = `Congratulations @${prAuthor}! ๐ŸŽ‰ + Your pull request has been successfully merged. + Thank you for your contribution and being part of our project! ๐Ÿ’ซ + Keep coding and keep shining! ๐ŸŒŸ`; + + await github.issues.createComment({ owner, repo, issue_number: prNumber, body: commentBody });# trigger diff --git a/.github/workflows/pullReqOpen.yml b/.github/workflows/pullReqOpen.yml new file mode 100644 index 0000000..9c55a9f --- /dev/null +++ b/.github/workflows/pullReqOpen.yml @@ -0,0 +1,24 @@ +name: PR opened comment +on: + pull_request: + types: + - opened + +jobs: + comment: + runs-on: ubuntu-latest + + steps: + - name: PR open + uses: actions/github-script@v4 + with: + github-token: ${{ secrets.MY_TOKEN }} + script: | + const { owner, repo, number } = context.issue; + const prAuthor = context.payload.pull_request.user.login; + const commentBody = `Hey @${prAuthor}! ๐ŸŽ‰ + Thanks for submitting your PR! Our maintainer will review it shortly. + Please ensure your PR follows the contributing guidelines. + Keep contributing and growing! ๐ŸŒฑโœจ`; + + await github.issues.createComment({ owner, repo, issue_number: number, body: commentBody });# trigger diff --git a/.github/workflows/selfAssign.yml b/.github/workflows/selfAssign.yml new file mode 100644 index 0000000..7614653 --- /dev/null +++ b/.github/workflows/selfAssign.yml @@ -0,0 +1,29 @@ +name: Self-assign on issue comment +on: + issue_comment: + types: + - created + +jobs: + assign: + if: contains(github.event.comment.body, '/assign') + runs-on: ubuntu-latest + + steps: + - name: Assign user to issue + uses: actions/github-script@v4 + with: + github-token: ${{ secrets.MY_TOKEN }} + script: | + const issueNumber = context.issue.number; + const assignee = context.payload.comment.user.login; + + await github.issues.addAssignees({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issueNumber, + assignees: [assignee] + }); + + console.log(`Assigned @${assignee} to issue #${issueNumber}`); +# trigger diff --git a/LICENSE b/LICENSE index b977304..80928fd 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,21 @@ -MIT License - -Copyright (c) 2025 NAYANIKA MUKHERJEE - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +MIT License + +Copyright (c) 2025 NAYANIKA MUKHERJEE + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index d58bb2e..c3a075b 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,111 @@ -# React + Vite Starter Template +
+ +[![Open Source Love](https://firstcontributions.github.io/open-source-badges/badges/open-source-v1/open-source.svg)](https://github.com/firstcontributions/open-source-badges) +[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) +[![Contributors Welcome](https://img.shields.io/badge/contributors-welcome-0b7cbd)](https://github.com/nikohoffren/fork-commit-merge/pulls) +[![First Contributors](https://img.shields.io/badge/first-contributors-0b7cbd)](https://github.com/nikohoffren/fork-commit-merge/pulls) +[![PR:s Welcome](https://img.shields.io/badge/PR:s-welcome-0b7cbd)](https://github.com/nikohoffren/fork-commit-merge/pulls) +[![Issues](https://img.shields.io/github/issues/Nayanika1402/WildQuest.svg?style=flat)](https://github.com/Nayanika1402/WildQuest/issues) +[![Stars](https://img.shields.io/github/stars/Nayanika1402/WildQuest.svg?style=flat)](https://github.com/Nayanika1402/WildQuest/stars) +[![Forks](https://img.shields.io/github/forks/Nayanika1402/WildQuest.svg?style=flat)](https://github.com/Nayanika1402/WildQuest/forks) +[![MIT License](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) +[![Follow](https://img.shields.io/badge/follow-%40Nayanika1402-1DA1F2?logo=twitter&style=social)](https://github.com/Nayanika1402) -This template provides a minimal setup to get **React** working with **Vite**, including **Hot Module Replacement (HMR)** and basic **ESLint** rules. +
---- +# What is WildQuest? -## ๐Ÿš€ Features +**WildQuest** is an interactive wildlife conservation platform designed to raise awareness and boost engagement through virtual animal adoptions, fun educational games, and quizzes. Join us in making wildlife conservation accessible, educational, and impactful for everyone. -- โšก๏ธ Fast build using **Vite** -- ๐Ÿ”ฅ Hot Module Replacement (HMR) -- โš›๏ธ Minimal **React** setup -- ๐Ÿงน Basic **ESLint** configuration -- ๐Ÿ“ฆ Ready to install dependencies and start coding +## ๐Ÿš€ Tech Stack ---- +WildQuest is built with: + +![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) +![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white) +![Firebase](https://img.shields.io/badge/firebase-ffca28.svg?style=for-the-badge&logo=firebase&logoColor=black) + +Deployed using: + +![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white) + +## ๐Ÿ› ๏ธ Getting Started for Contributors + +We welcome contributions to ! Follow the WildQuest steps below to get started: + +1. **Fork the Repository** + - Click on the "Fork" button at the top right corner of the GitHub repository page. + +2. **Clone the Forked Repository** + - Use the following command to clone the forked repository to your local machine: + + ```bash + git clone https://github.com/Nayanika1402/WildQuest.git + ``` + +3. **Create a Branch** + - Create a new branch for your feature or bug fix: + + ```bash + git checkout -b feature/your-feature-name + ``` + +4. **Make Your Changes** + - Implement your feature or fix the bug. Ensure your code is clean and well-documented. + +5. **Commit Your Changes** + - Stage your changes and create a commit: -## ๐Ÿ“ฆ Plugins Used + ```bash + git add . + git commit -m "add commit message" + ``` -### Official Vite Plugins: -- [`@vitejs/plugin-react`](https://www.npmjs.com/package/@vitejs/plugin-react) โ€“ uses **Babel** for Fast Refresh -- [`@vitejs/plugin-react-swc`](https://www.npmjs.com/package/@vitejs/plugin-react-swc) โ€“ uses **SWC** for Fast Refresh (faster) +6. **Push Your Changes** + - Push your branch to your forked repository: + + ```bash + git push origin your-branch-name + ``` + +7. **Submit a Pull Request** + - Go to the original repository and click on "New Pull Request". + - Select your branch and submit the pull request for review. --- -## ๐Ÿงช Linting and Formatting +## ๐Ÿš€ Open Source Program + +This project is a part of **GirlScript Summer of Code 2025 (GSSoC '25)**. + +![GSSoC '25 Logo](https://tse1.mm.bing.net/th/id/OIP.h7OBAsph2Bb1K4W9C6jiLQHaCS?pid=Api&P=0&h=180) + +We welcome enthusiastic contributors from GSSoC โ€™25 and beyond to help improve and expand the project. + -Basic ESLint rules are included. -For production-level apps, we recommend: +## ๐Ÿค Our Contributors -- Using **TypeScript** -- Enabling **type-aware** ESLint rules with `typescript-eslint` + + + -๐Ÿ‘‰ Check the [TypeScript version of this template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for full setup. +--- + +## ๐Ÿ›ก๏ธ License + +This project is licensed under the MIT License. See the [LICENSE](link-to-license-file) file for more details. --- -## ๐Ÿ› ๏ธ Getting Started +## ๐Ÿ“ฌ Contact + +If you have any questions, feel free to open an issue or reach out to the project [maintainer](https://www.linkedin.com/in/nayanika-mukherjee-76a24027b/). + +- [Nayanika Mukherjee](https://github.com/Nayanika1402) + +**Please โญ the repository to show some love!** -```bash -npm install -npm run dev +
+ back to top +