VRapeutic's Official Documentation Website 📝 💻 🚀

Installation 🖥

• Start off by cloning the repository

git clone https://github.com/vrapeutic/vrapeutic.github.io.git
cd vrapeutic.github.io

• Install the dependencies using Yarn or NPM

npm install

or

yarn install

Start Your First Contribution 🌟

Create a development branch

• Start off by creating a new branch for your work

git checkout -b <branch-name>

• Make your branch name descriptive to the thing you want to work on

Local Development 🧱

• After you've done some modifications, you might want to run your changes in your local environment
• In order to start the documentation website locally on your local machine, run the following command

yarn start

or

npm start

• This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build 🏗

• This is an important step. It compiles the documentation website into a static website
• In order to build the documentation website, run the following command

yarn build

or

npm run build

• This command generates static content into the build directory and can be served using any static contents hosting service

Create a PR (Pull Request) ⤴

• Once you feel comfortable with your changes, commit you work to your branch

git commit -am "A brief description of your changes"

• Make your commit message descriptive to the thing you want to work on
• Add some emojis to your commit message to make it easy to identify what you've done
• Push your branch to GitHub

git push origin <branch-name>

• Go to GitHub and create a pull request
• Describe your changes in detail
• Include screenshots and animated GIFs to show how your changes look
• Wait for the PR to be reviewed and merged
• Once merged, changes will be reflected live on vrapeutic.github.io
• Hurray!!! You've done an amazing job and we're proud of you! 🚀

Issues 💡

• We're really appreciate your keeness to making VRapeutic's documentation website better! 😇
• Start off by going to the Issues tab, and create a New Issue
• You can choose from different template for the issue (e.g. Bug Report, or Feature Request), or you can just write your own description
• Fill out the issue template and submit the issue
• If you want to help us out, you can start a discussion on the issue
• Make your issue as descriptive as possible, and include as much details as you can
• We encourage you to attach images, screenshots, or even use Emjoin to make your issue more visual

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Yahya Alaa 💻 🖋 🎨 📖 🤔 🚇 🚧 📆 🌍	Ahmad Al-Kabbany 💼 🖋 🤔 🧑‍🏫 📆	J.W.F. (he/him) 💬 🐛 🤔 🔧	Alaa Hesham 📝 💻 🖋 🔬
hadeergamal1 💻 🖋 📖 🤔 📓	AhmedAlassasy 💻 🖋 📖 🤔 📓

This project follows the all-contributors specification. Contributions of any kind welcome!