Skip to content

Quickstart to get you up and on your feet at hackathons!

License

Notifications You must be signed in to change notification settings

TechHacks-Competitive/Hack-n-Go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hack n Go

Expect more. Search less

To be submitted as part of the "Suns Out, Hacks Out" hackathon by MLH

Video Demonstration

Hack-n-Go Vide Demonstration

Inspiration

In our team, we used to have a member who knew the Python programming language, but didn't know anything at all about the basic tools that was like common knowledge to the rest of us. We knew how frustrating it was seeing our young team member struggle, but not being able to do anything because we've long since forgotten how we learned it. So, we built Hack N Go, for our young team member as a way to give back to our new hacker and hackers abroad.

How we Built it

Using Domain.com and mkdocs, a tool designed for creating websites aimed towards guides and documentation, we've managed to build a hosted website that has a few tutorials and guides that are aimed towards the new hacker community. We decided to use the principle of VARK (Visual, Auditory, Reading, Kinesthetic) in our guides in order to address the need of hackers who have different learning styles.

Challenges we ran into

It was our first time using Domain.com and we couldn't get the domain DNS record set up correctly. Try as we might we couldn't figure it out until we contacted the support group and they helped us out. As I was not the only one who had this problem, it felt a bit humbling to see that there are so many things that we just don't know but are there for grabs.

What we learned

We learned that the authors of almost all open source guides and tools have had a lot of work in front of them when first starting to write their guides and documentation. It was a humbling experience as we got to see how hard it was to write so much in detail and clarity that we developers often take for granted.

What’s next for Hack 'n Go

We want to extend the guides and flesh them out, if you will, with more details and guides for beginner hackers. We understand that our ambitious goal of writing guides out from scratch was too expensive in terms of time. We beat ourselves by the foot because of it and we hope that this MVP is a testament to what will become. Overall, the final website will feature fully fledged guides with multiple versions of those guides, each addressing a young hacker's learning method.

Check-List

  1. Introduction to Hackathons, CTFS, HackCons, etc.
  2. Discord noobie guide.
  3. Devpost noobie guide.
  4. Idea creation guide.
  5. Team creation guide.
  6. Git noobie and advanced guide.
  7. Heroku noobie guide.
  8. Homebrew
  9. Hardware noobie guide.
  10. Github Student Developer Pack guide.
  11. API noobie guide to JSON formats, REST, POST and GET requests.

Feature List

  • Curated images, graphs, Infographics.
  • Curated Abstractions.
  • Curated Analogies.
  • Curated Assignment Projects.
  • Curated list of videos.
  • Example code to run.
    • We'll be using this compiler widget for our online ide.
  • Noob version AND Advanced version of each guide. (might not be done by the end) at least have this for common stuff like git.

Github Repo

https://github.com/TechHacks-Competitive/Hack-n-Go

About

Quickstart to get you up and on your feet at hackathons!

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •