diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 4f6446e83..38e5944b9 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -48,10 +48,9 @@ body: - label: "I am willing to work on this issue (optional)" required: false - - label: "I am a SWOC'24 contributor" - required: false - - label: "I am an IWOC 2.0 contributor" + - label: "I am a GSSOC'24 contributor" required: false + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index d20349b36..bfea735bb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -34,8 +34,5 @@ body: - label: "I am willing to work on this issue (optional)" required: false - - label: "I am a SWOC'24 contributor" - required: false - - - label: "I am an IWOC 2.0 contributor" + - label: "I am a GSSOC'24 contributor" required: false diff --git a/.github/ISSUE_TEMPLATE/styles.yml b/.github/ISSUE_TEMPLATE/styles.yml index 92d39494e..921f9ac0c 100644 --- a/.github/ISSUE_TEMPLATE/styles.yml +++ b/.github/ISSUE_TEMPLATE/styles.yml @@ -35,6 +35,6 @@ body: - label: I agree to follow this project's Code of Conduct required: true - - label: I'm a SWOC'23 contributor + - label: I'm a GSSOC'23 contributor - label: I want to work on this issue diff --git a/.github/workflows/auto-comment-on-pr-merge.yml b/.github/workflows/auto-comment-on-pr-merge.yml new file mode 100644 index 000000000..f07afe1c7 --- /dev/null +++ b/.github/workflows/auto-comment-on-pr-merge.yml @@ -0,0 +1,21 @@ +name: Auto Comment on PR Merge + +on: + pull_request: + types: [closed] + +jobs: + comment: + if: github.event.pull_request.merged == true + runs-on: ubuntu-latest + + steps: + - name: Add Comment to Merged PR + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + curl -X POST \ + -H "Authorization: token $GITHUB_TOKEN" \ + -H "Accept: application/vnd.github.v3+json" \ + -d '{"body":"🎉 Your pull request has been successfully merged! 🎉 Thank you for your contribution to our project. Your efforts are greatly appreciated. Keep up the fantastic work! 🚀"}' \ + "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments" diff --git a/.vscode/settings.json b/.vscode/settings.json index f673a71b7..155422b0a 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,3 +1,3 @@ { - "liveServer.settings.port": 5502 + "liveServer.settings.port": 5503 } \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..a9940036c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,30 @@ +# Virtuo-Learn - GSSoC'24 Contributors Code of Conduct + +# Contribute yourself with the following code of conduct + +## Our Pledge + +We are committed to creating a diverse and inclusive community where everyone feels respected and valued.This code of conduct outlines the expectations for all participants and the steps we will take to enforce them. Any unexpected behaviour will lead to take actions on them. + +## Our Standards + +The following are the examples of behaviour that create a positive and friendly environment + + - Be respectful: Treat all contributors with courtesy and avoid discriminatory or offensive language. + - Be constructive: Offer helpful feedback and suggestions for improvement. + - Be open-minded: Consider different perspectives and approaches. + - Be responsible: Report any abusive or harassing behavior to the project maintainers. + - Be collaborative: Work together to achieve the project's goals. + +The following are the examples of unacceptable behaviour: + +Harassment: Any behavior that is deemed threatening, intimidating, or discriminatory will not be tolerated. +Spam: Do not spam the project repository or communication channels with irrelevant or promotional content. +Violence or threats of violence: This will not be tolerated under any circumstances. +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. \ No newline at end of file diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index d33e98d2d..a8e67e595 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -48,6 +48,40 @@ git push origin feature/your-feature 6. **Open a pull request on the main repository with a detailed description of your changes.** +### Alternatively contribute using GitHub Desktop + +1. **Open GitHub Desktop:** + Launch GitHub Desktop and log in to your GitHub account if you haven't already. + +2. **Clone the Repository:** + - If you haven't cloned the Virtuo-Learn repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository." + - Choose the Virtuo-Learn repository from the list of repositories on GitHub and clone it to your local machine. + +3. **Switch to the Correct Branch:** + - Ensure you are on the branch that you want to submit a pull request for. + - If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch. + +4. **Make Changes:** + Make your changes to the code or files in the repository using your preferred code editor. + +5. **Commit Changes:** + - In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit. + - Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch. + +6. **Push Changes to GitHub:** + After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub. + +7. **Create a Pull Request:** + - Go to the GitHub website and navigate to your fork of the Virtuo-Learn repository. + - You should see a button to "Compare & pull request" between your fork and the original repository. Click on it. + +8. **Review and Submit:** + - On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request. + - Once you're satisfied, click the "Create pull request" button to submit your pull request. + +9. **Wait for Review:** + Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the Virtuo-Learn repository. + # Coding Guidelines When contributing code, please adhere to the coding guidelines and best practices: @@ -67,4 +101,4 @@ If you are fluent in multiple languages, you can contribute by translating the p # Contact -If you have any questions or need further assistance, you can contact us at jayeshbatra1@gmail.com. \ No newline at end of file +If you have any questions or need further assistance, you can contact us at jayeshbatra1@gmail.com. diff --git a/LEARN.md b/LEARN.md new file mode 100644 index 000000000..b014caf03 --- /dev/null +++ b/LEARN.md @@ -0,0 +1,50 @@ +# Virtuo - Learn +Visit our website [Virtuo - Learn]https://virtuo-learn.vercel.app/ + +## Table of Contents + - Introduction + - Features + - Getting Started + - Contribuitng Guidelines + - Code of Conduct + +## Introduction + Virtuo-Learn is a platform that provides immersive learning experiences like never before. It offers simulations, 3D visualizations, customized quizzes, doubt engine, and videos, all in one place. + +## Features + - 🧩Simulations : Interactive simulations to enhance practical understanding. + - 🌐3D Visualizations : Engaging 3D models for better conceptual clarity. + - 📝Quizes with personalized recommendations : Tailored quizzes to track progress and provide personalized learning paths. + - 🎥Videos : Comprehensive video tutorials covering various topics. + - ❓Doubt Engine : A robust doubt-solving mechanism to ensure no question goes unanswered. + + ## Getting Started +1). First fork the repository +2). Clone the project locally using : + ``` + git clone https://github.com/User-name/Virtuo-Learn.git + ``` +3). Open terminal and run command: + ``` + cd Virtuo-Learn + ``` +4). Add remote using command: + ``` + git remote add origin https://github.com/User-name/Virtuo-Learn.git + ``` +5). Setup upstream using command + ``` + git remote add upstream https://github.com/JAYESHBATRA/Virtuo-Learn.git + ``` +6). Make sure you have **Live Server** extension installed on your code editor if you're using vs-code. +7). Finally run index.html using Go live. + + + + ## Contribuitng Guidelines +For the enthusiasts who want to contribute to CodeHarbourHub, please refer to our [Contibuting]https://github.com/JAYESHBATRA/Virtuo-Learn/blob/main/CONTRIBUTION.md + + ## Code of Conduct +For all the enthusiastic contributers, please refer to the Code of Conduct file. + +Happy Coding!! diff --git a/Pages/3D-Visualizations/index.html b/Pages/3D-Visualizations/index.html index 169d51c01..a888ac6e8 100644 --- a/Pages/3D-Visualizations/index.html +++ b/Pages/3D-Visualizations/index.html @@ -16,21 +16,36 @@