METAVERSE
π Open Source Program
This project is now OFFICIALLY accepted for
This project was part of following Open Source Programs
Welcome to the "Metaverse Front-End Playground" β your gateway to the future of web development in the metaverse! ππ
Metaverse Front-End Playground is an open-source repository created to empower developers to explore, innovate, and collaborate in the metaverse space. Whether you're a seasoned developer looking to showcase your metaverse projects or a newcomer eager to dive into the virtual realm, you're invited to join our dynamic community!
We also have a Discord server to discuss doubts and suggestions! Make sure to join it here:
Announcement π’
All of the projects of this repo can be seen in the deployment link in the about section
Achievement π
METAVERSE repo has secured a position in top 50 maintainer repositories in QUINE HACTOBERFEST challenge π
Available Projects
& many more.......
You can find All the Projects
Live Project -- https://apu52.github.io/METAVERSE/
Blog
What You'll Discover Here:
- Diverse Metaverse Projects:
Our repository features a wide spectrum of metaverse-related front-end projects. From HTML, CSS, and JavaScript to immersive React experiences, you'll find projects that push the boundaries of the metaverse.
- π€ Collaboration:
Metaverse Front-End Playground thrives on collaboration. You can enhance existing metaverse projects, contribute new features, or even conjure up entirely new metaverse experiences. Your creative contributions are highly valued!
- πLearning Opportunity:
If you're new to metaverse development, this repository is an excellent launchpad. Collaborate with experienced metaverse developers, gain valuable insights, and immerse yourself in creating groundbreaking virtual worlds.
What can you contribute?
- Find All the details in [**CONTRIBUTING.md**](https://github.com/apu52/METAVERSE/blob/main/CONTRIBUTING.md) before contributing
- Please follow guidelines in [**Code_of_Conduct.md**](https://github.com/apu52/METAVERSE/blob/main/Code_of_conduct.md)
How to contribute?
- Drop a Star in this repo
- Take a look at the existing [Issues](https://github.com/apu52/METAVERSE/issues).
- Fork the Repo create a branch for any issue that you are working on and commit your work.
- At first raise an issue in which you want to work
- **Please do not make more than 2 issues at a time , Once your PR have been merged only then go for the next issue**
- **Then when you are get assigned only then work on that issue & make a PR**
- Please try to make a separate branch in your fork in case of PR
- Create a [**Pull Request**](https://github.com/apu52/METAVERSE/pulls), which will be promptly reviewed and given suggestions for improvements by the community.
- **REMINDER: Commit inside **the `Projects`** Folder**
- Find the already Existing Projects in the `Projects` Folder
- Add screenshots or video prototypes to your Pull Request to help us understand the effects of the changes that are included in your commits.
Installation and Setup
Prerequisites
- Node.js
- npm
Steps
1. **Clone the repository**:
```bash
git clone https://github.com/apu52/METAVERSE.git
```
2. **Navigate to the project directory**:
```bash
cd METAVERSE
```
3. **Install Dependencies**:
```bash
npm install
```
4. **Run the project**:
```bash
npm start
```
5. **Contribution Guidelines**
Move detailed steps to a new `CONTRIBUTING.md` file and link to it:
How to make a Pull Request?
**1.** Start by forking the [**METAVERSE**](https://github.com/apu52/METAVERSE) repository. Click on the
symbol at the top right corner.
**2.** Clone your forked repository:
```bash
git clone https://github.com/
/METAVERSE
```
**3.** Navigate to the new project directory:
```bash
cd METAVERSE
```
**4.** Set upstream command:
```bash
git remote add upstream https://github.com/apu52/METAVERSE
```
**5.** Create a new branch:
```bash
git checkout -b YourBranchName
```
or
```bash
git branch YourBranchName
git switch YourBranchName
```
**6.** Sync your fork or local repository with the origin repository:
- In your forked repository click on `Fetch upstream`.
- Click `Fetch and merge`.
Alternatively, Git CLI way to Sync forked repository with origin repository:
```bash
git fetch upstream
```
```bash
git merge upstream/main
```
Github Docs for Syncing
Read the documentation
**7.** Make your changes to the source code.
**8.** Stage your changes and commit:
β οΈ **Make sure** not to commit `package.json` or `package-lock.json` file
β οΈ **Make sure** not to run the commands `git add .` or `git add *`. Instead, stage your changes for each file/folder
```bash
git add file/folder
```
```bash
git commit -m ""
```
**9.** Push your local commits to the remote repository:
```bash
git push origin YourBranchName
```
**10.** Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)!
**Congratulations! You've made your first contribution!** ππΌ
Quick Docker Setup π³
Requirement:
* Docker Desktop
Let's Begin:
1. Make sure you have followed steps 1, 2, and 3 from the above procedure.
2. Verify Docker Status:
To ensure a seamless Docker experience, it's essential to check the status of the Docker service on your system.To verify whether the Docker service is currently active or inactive, you can use the following steps:
* Check Docker Service Status:
```bash
systemctl status docker
```
if it's inactive, you'll need to take corrective action.
* To activate the Docker service, use the following command:
```bash
systemctl start docker
```
3. Build
Now, let's build the Docker image named 'metaverse' using the docker build command:
```bash
docker build -t metaverse .
```
4. Run
Write the following command to run a Docker container named 'metaverseee'
```bash
docker run -d -p 3000:80 --name metaverseee metaverse
```
5. Wait until the ***[Container ID]*** appears.
6. Search the following syntax in your web browser to view the website.
```bash
localhost:3000
```
7. Stop:
Run the following command to stop the Docker container:
```bash
docker stop [container ID]
```
Show some β€οΈ by giving to this repo
GSSOC'24 Mentor π¨βπ»
Sagnik Sahoo
|
SSOC'24 Mentor π¨βπ»
Anurag Verma
|
METAVERSE Project Moderators(admin)
Shuvadipta Das
|
Shruti Sen
|
Ankita Sikdar
|
Project Admin
Arpan Chowdhury
|
Project Contributors
Thank you to all the amazing contributors who have made this project possible!!π
License