Hash Whiteboard
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.
This is Hash-Whiteboard, made with ReactJS, NodeJS, Socket-IO, Material-UI.
🌟Getting started
:dart: Let's celebrate Hacktoberfest by getting involved in the open source community and start your journey in open source.
:dart: We at Hash Define aim to build a platform that will not only encourage you to find which domain interests you but will also help you to come forward and gain expertise in that.
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
-
Fork the Repository
-
Clone the Forked Repository to your local machine.
git clone https://github.com/<your GitHub user name>/Hash-Whiteboard.git. -
Change the directory to Hash-Whiteboard.
cd Hash-Whiteboard -
Add remote to the Original Repository.
git remote add upstream https://github.com/hash-define-organization/Hash-Whiteboard.git -
Install the dependecies.
- using npm
npm install - using yarn
yarn
- using npm
-
Run the application.
- using npm
npm start - using yarn
yarn start
- using npm
-
The app starts on
localhost:3000. If not, Click here to open the app in browser.
:label: Participation Rules 📝
➡️ Pull requests can be made to any public repository on GitHub, look for the "hacktoberfest" topic to know whether the project is participating or not.
➡️ The pull request must contain commits you made yourself.
➡️ If a maintainer reports your pull request as 🔴 spam , it will not be counted towards your participation in Hacktoberfest.
➡️ If a maintainer reports behavior that’s not in line with the project’s code of conduct, you will be ineligible to participate.
:label: Rules Regarding Submission of PR :bookmark:
➡️ Participants can freely provide valuable contributions.
➡️ Ensure that you submit a pull request in the appropriate folder.
➡️ Your PR must be valid.
➡️ Refrain from simply copying code from websites or blogs.
➡️ Submitting someone else's work will be reported as 🔴 spam.
➡️ Please read Contributing.md for details about the process for submitting pull requests to us.
Show your support
Give a ⭐ if you like this repository.
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. 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.