Blueprint

Submission guidelines!

Ready to submit your project? Right this way!

The main thing we check for is whether or not your project is shipped - see - what is shipping?. The requirements below are a bare minimum, not the goal - you're encouraged to go above and beyond! Add a 3D render, custom logo, and more!

Requirements

1. Your project is original

If you follow guides from online or even from the guides, thats fine! However, you need have an original touch to the project. This is something different for every project. For the split keyboard, maybe add lights that flash different colors based on the program, etc. We WILL verify that your project is original even if you create it from some obscure guide.

2. Your project is actually shipped & complete

The tl;dr of what this means is:

YOUR PROJECT IS ACTUALLY COMPLETE:

  • [x] It has a complete CAD assembly, with all components (including electronics)
  • [x] You have firmware present, even if it's untested
  • [x] You have sanity checked your design with someone else
  • x you have a 3D render of your project!

YOUR GITHUB REPOSITORY CONTAINS ALL OF YOUR PROJECT FILES:

  • [x] a BOM, in CSV format in the root directory, WITH LINKS
  • [x] the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc)
  • [x] A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc)
  • [x] ANY other files that are part of your project (firmware, libraries, references, etc)

if you're missing a .STEP file with all of your electronics and CAD, your project will not be approved

YOUR README.md FILE CONTAINS THE FOLLOWING:

  • [x] A short description of what your project is
  • [x] A couple sentences on why you made the project

PICTURES OF YOUR PROJECT\

  • [x] A screenshot of a full 3D model with your project
  • [x] A screenshot of your PCB, if you have one
  • [x] A wiring diagram, if you're doing any wiring that isn't on a PCB
  • [x] A BOM in table format at the end of the README

YOU DO NOT HAVE:

  • [ ] AI Generated READMEs or Journal entries
  • [ ] Stolen work from other people
  • [ ] missing firmware/software

Any project that includes stolen content, AI-generated readmes or journals, or other fraudulent/dishonest material may be permanently rejected and could result in a ban from Blueprint and other Hack Club programs!

3) You have a quality journal

Your journal is very important for Blueprint! Not only does it allow us to verify the hours you spent, it also allows for other people to look back at your project and follow it's journey. Here are some important things to keep in mind while journaling:

  • Try to keep each entry under 5 hours, this is not a hard requirement but your project will be more likely to be rejected
  • Take into account your thoughts while making a project
  • Don't just log the steps that led to your final project! You should have all of your failures and rabbit holes that didn't end up making it to the final piece.

There is no magic bullet, but as long as you put an honest effort forward you will almost certainly be approved.

5) Your project is cost optimized!

You should always aim to make your project as cheap as possible!

  • Always get the minimum quantity of your project. We are funding your project to learn not to mass-produce things like merch. On JLCPCB for example, this means only 5 PCB's, or 2 PCBA's.

  • JLCPCB Specific: Always choose parts for your PCB which allow you to use economic assembly rather than standard. Try and keep your PCB under 100x100mm if possible and choose Global Standard Direct (or Air Registered Mail if it is cheaper) shipping when you can.

If you have all of that, you should be good to go! Go ahead and submit your project :)