vaibhavupreti / hash-whiteboard

Whiteboard Built with ReactJS and Material UI 🚀❤️

Hash Whiteboard

This is Hash-Whiteboard, made with ReactJS, NodeJS, Socket-IO, Material-UI.

Motive

This Repository is created with a motive to guide beginners with the open-source and with big react projects. I have already created some issues for the beginners so that they can work on them and even make there first contribution in this repository.

Instructions

You can test this project in your create-react-app feature by replacing the files.

Supported Platforms

This app can be built on any platform. It can be Windows, Linux , MacOS or any other. You only need the create-react-app feature and rest is in the Dependencies section.

Dependencies

I am writing down the Dependencies for beginners, so that they can look into it and then understand and install them if they want to.

• ReactJS
• NodeJS
• Socket-IO

Installation and Setup

1. Fork the Repository

   

2. Clone the Forked Repository to your local machine.

   git clone https://github.com/<your GitHub user name>/Hash-Whiteboard.git.
   

3. Change the directory to Hash-Whiteboard.

   cd Hash-Whiteboard

4. Add remote to the Original Repository.

   git remote add upstream https://github.com/hash-define-organization/Hash-Whiteboard.git
   

5. Install the dependecies.

   • using npm

   npm install

   • using yarn

   yarn

6. Run the application.

   • using npm

   npm start

   • using yarn

   yarn start

7. The app starts on localhost:3000. If not, Click here to open the app in browser.

Important points to remember while contributing

• Writing a blog about your contribution is a must after getting your PR merged! Otherwise, maintainers have right to revert the PR.
• Make sure to fork the repository and run the code in your local environment, then only you will get assigned to an issue.

Connect with me

• Twitter
• Medium
• Gmail
• LinkedIn

Show your support

Give a ⭐ if you like this web-app.

FAQs

1. I am a beginner with open source or with react can I contribute in this repository ?

Anybody can contribute to this project. Just take an issue, give your ideas, work on the issue and I am always here to guide you throughout the process ❤ .

2. What are the steps to make my first contribution ?

Kindly refer to the Contributing.md file. All the contributing guidelines are written over there.

3. Is there any need to assign myself to the issue before starting to work on the issue ?

It is better to wait until you are assigned to the issue. Although if you are make sure that no-one is working on the issue then you can start working on the issue.