Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 5.06 KB

README.md

File metadata and controls

65 lines (44 loc) · 5.06 KB
Raw

website

Pull Requests Welcome first-timers-only Friendly GitHub Hacktoberfest combined status

Hello, and welcome to the home for the code that makes up P2P Hack Club's website at https://p2phack.club! P2P Hack Club is a programming club at Peak to Peak Charter School, where we build apps, websites, games, and other technology projects.

Contributing

This website uses a technology called Jekyll to build its files.

How to edit and contribute changes to the website:

(These instructions have been written really quickly using macOS, if you can make these instructions clearer, please contribute to this repository!)

  1. Download GitHub Desktop
  2. Log-in/Sign-up using a GitHub account into GitHub Desktop.
  3. On https://github.com/P2PHackClub/website, follow these instructions to clone the repository P2PHackClub/website from GitHub to GitHub Desktop.
  4. Follow these instructions to configure a default editor with GitHub Desktop
  5. In the menu bar, use the "Repository" drop down menu and click "Open in [your default editor]"
  6. If your default editor includes a terminal, open it. If it doesn't, in the menu bar, use the "Repository" drop down menu and click "Open in Terminal".
  7. Install ruby (this guide for macOS is really great- https://www.moncefbelyamani.com/the-definitive-guide-to-installing-ruby-gems-on-a-mac/)
  8. Type gem install bundler jekyll into your terminal.
  9. Type bundle install
  10. Type bundle exec jekyll serve
  11. Navigate to http://localhost:4000 in your browser, and you should see the local version of the site!

Make any changes you want in your code editor, save the files, and refresh your browser to see the changes. You can just repeat steps 11-12 to run the server again if you close your terminal.

When you're done, commit your changes to the project!

License

This project is licensed under the MIT License. For more information, please check the LICENSE file.

Code of Conduct

If you join in or contribute to the P2P Hack Club community in any way, you are encouraged to follow the Code of Conduct while doing so. Please read our Code of Conduct at http://community.p2phack.club/CONDUCT.html.