Blueprint

Submission requirements!

Here's everything you need to know to get your project approved! Before going through this checklist, you should've read the project guidelines

The goal of Blueprint is to get you creating shipped projects. It is the only thing we check for - we try not to have any unnecessary / arbitrary requirements.

The following is a list of hard requirements from us, missing any of these will automatically get your project returned

any questions? ask in #blueprint!


Requirements

YOUR README.md FILE CONTAINS THE FOLLOWING:

A DESCRIPTION/EXPLANATION OF YOUR PROJECT
A short description of what your project is
A couple sentences on how to use your project!
A couple sentences on why you made the project

PICTURES OF YOUR PROJECT
A screenshot of a full 3D model with your project
A screenshot of your PCB, if you have one
A wiring diagram, if you're doing any wiring that isn't on a PCB
A BOM in table format at the end of the README, with links

YOUR PROJECT DESIGN IS FULLY COMPLETE:

It is an original, customized design by you, and is not a direct copy of any guide!
It has a complete CAD assembly, with all components (including electronics!)
You have firmware present, even if it's untested
You have sanity checked your design with someone else!

YOUR GITHUB REPOSITORY CONTAINS ALL OF YOUR PROJECT FILES:

a BOM, in CSV format in the root directory, WITH LINKS
the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc)
A .STEP file of your project's 3D CAD model as well as the source design file format as well - .f3d, .FCStd, etc; for OnShape, add a public link to your README)
ANY other files that are part of your project (firmware, libraries, references, etc)
You have everything easily readable and organized into folders.

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

YOU DO NOT HAVE:

AI Generated READMEs, Journal entries, or an image of your project
Taken designs from other people
Missing firmware/software

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


Examples

Here are some examples of well-shipped projects made by Hack Clubbers! They're seriously awesome

For more examples (and non hack club projects!), check out what is shipping?

think your project should be here? dm @alexren!















--this space is intentionally left blank--