Binari v0.9.0
Interactive code editor with a live binary tree visual designed to teach new developers the fundamentals of data structures and algorithms.
Site Navigation
- Home - Basic introduction to the application.
- Playground - The primary learning route. Includes the code editor and canvas.
- About - Application description w/ github API integration for contributor info.
Built With
- React - Front-End Framework.
- P5 - Canvas editor.
- Material UI Pro - Design System.
Contributing
Anyone can help. We welcome first-time contributors, as well as experienced contributors.
There is plenty to do for both developers and designers of every skill level. Check out the issues, or pitch your own ideas.
Starting points.
- New to open-source? I suggest fixing a spelling error or try doing a first-timers-only issue.
- Expert on all things binary tree? Try building a lesson.
- Designer? Don't be shy, we could use some work with our designs.
Rules
- Read the rules!
- Issues tagged with
first-timers-onlyare reserved for new contributors. Let them have a chance. - Each pull request should only introduce a single update at a time. Do not reference multiple issues that are unrelated to one-another.
- Attempt to match the coding style of the project.
- Adhere to the Code of Conduct, outlined below.
Setup and Contributing Changes
-
Fork the repo into your GitHub account (available in the top right corner).
-
Clone the forked repo.
git clone https://github.com/<yourgithubaccount>/Binari.git
- Navigate to the Binari directory and create/switch to a new branch.
cd Binari
git checkout -b <branch-name>
- Make changes to files. To see the changes you are making reflected in the application, run
npm install
npm start
Build the project.
- Add the edited files and commit your changes.
git add <files>
git commit -m "<add message describing your changes>"
- Push the changes to the remote repo.
git push -u origin <branch-name>
In the future, you can simply push to this branch by running git push.
-
Navigate back to your forked version of the project, where GitHub will ask if you would like to open a Pull Request. Create a PR, adding a description of your changes, the purpose of the changes, and a link to the issue you are solving.
-
Your PR will be reviewed by other members, who will either approve the merge or request changes.
Contributors
Made with contrib.rocks.
Stargazers
Code of Conduct
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
License
This project is licensed under the MIT License - see the LICENSE.md file for details