Skip to content

Commit

Permalink
Merge pull request #359 from aasthakourav20/addingfiles
Browse files Browse the repository at this point in the history
Fix: Adding necessary files - Code of Conduct  Learn.md and Enhanced Readme
  • Loading branch information
JAYESHBATRA authored Jun 7, 2024
2 parents 71157b8 + 1542871 commit f3cb385
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 16 deletions.
30 changes: 30 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
50 changes: 50 additions & 0 deletions LEARN.md
Original file line number Diff line number Diff line change
@@ -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!!
44 changes: 28 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<img width="952" alt="6" src="https://user-images.githubusercontent.com/112322302/234294672-145c9272-6ff9-490a-b6a8-a70de0432f79.png">
# Virtuo- Learn

Virtuo Learn
Welcome to Virtuo-Learn , it 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.

<img width="952" alt="6" src="https://user-images.githubusercontent.com/112322302/234294672-145c9272-6ff9-490a-b6a8-a70de0432f79.png">

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.


## 🔗 Links
Expand All @@ -21,11 +21,11 @@ Vercel: https://virtuo-learn.vercel.app

## Features

- Simulations
- 3D Visualizations
- Quizes with personalized recommendations
- Videos
- Doubt Engine
- 🧩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.


## Tech Stack
Expand All @@ -34,13 +34,25 @@ Vercel: https://virtuo-learn.vercel.app

## Setup Guide

- First fork the repository
- Clone the project locally using git clone https://github.com/User-name/Virtuo-Learn.git
- Open terminal and run command cd Virtuo-Learn
- Add remote using command git remote add origin https://github.com/User-name/Virtuo-Learn.git
- Then setup upstream using command git remote add upstream https://github.com/JAYESHBATRA/Virtuo-Learn.git
- Make sure you have **Live Server** extension installed on your code editor if you're using vs-code
- Finally run index.html using Go live
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.

## Screen Shots

Expand All @@ -59,9 +71,9 @@ Vercel: https://virtuo-learn.vercel.app
<!-- --------------------------------------------------------------------------------------------------------------------------------------------------------- -->

<h2>Contributing is fun🧡</h2>
Contributions are always welcome! 🎉

## Feedback

If you have any feedback, please reach out to us at [email protected]


0 comments on commit f3cb385

Please sign in to comment.