Cheatsheets are very handy tool. Because it is not possible for us to remember all the commands or functions of a library at once. In that case, if we make a list of such commands or function does such a thing, then very easily when someone wants to work later, they can find everything they need just by looking at that list. We can divide our entire knowledge into different categories and list only the actual functionality very briefly. In which later an ethical hacker/security researcher will find what he wants with just a quick glance.
This project is completely GitHub based. This is where all our cheatsheets are organized as json files inside a directory called data. Our main application will display the data from here. We currently support two formats of cheatsheets.
- Format with code and description(See demo here)
- Code Only(See demo here)
- mix (see demo here)
Any new formats will be added in future if needed. If you want from can create an issue to create a new format.
Contributing Guidelines📝
You are welcome to contribute to this project. To start contributing, follow the below guidelines:
- Fork this repository.
- Clone your forked copy of the project.
git clone https://github.com/<your_user_name>/hack101.info.git - Navigate to the project directory.
cd hack101.info - Add a reference(remote) to the original repository.
git remote add upstream https://github.com/anyxel/hack101.info.git - Check the remotes for this repository.
git remote -v - Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
git pull upstream main - Create a new branch.
git checkout -b <your_branch_name> - Perform your desired changes to the code base.
- Track your changes.
git add . - Commit your changes.
git commit -m "relevant message" - Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name> - To create a pull request, click on compare and pull requests.
- Add an appropriate title and description to your pull request explaining your changes and efforts.
- Click on Create Pull Request.
- Woohoo!🥳 You have made a PR to the Hack101. Wait for your submission to be accepted and your PR to be merged. You made it! 🎊
- This project is inspired by and fork of DevSonket. A big thanks to DevSonket team. ❤️
If you also want to sponsor Hack101 in any way, or organize an event for Hack101 please let us know.