Back
Edit on GitHub
jam / onboard-grant
Hardware
1 Hour

Get a PCB Grant

MaxWofford

In this jam you'll take an existing design you've made and submit it to the OnBoard repo, an open-source collection of other designs, to request your $100 manufacturing grant.

If you don't already have a design, go to jams.hackclub.com/jam/hacker-card to make one!

This is a shortened version of the full submission instructions for the grant.

Required Materials

  • A PCB design: If you don't have one you can make one here: https://jams.hackclub.com/jam/hacker-card
  • A GitHub account: If you don't have one, create one here: https://github.com/join
  • 60 minutes: It'll take a bit less time if you have experience with GitHub, but if you're new to it, it'll take a bit longer. If you don't have enough go to the time store.
  • A good time: This one's on you~

Star the repo (Optional)

To follow the repo for updates and show you're participating, click the "star" button on the hackclub/onboard repo.

Star the OnBoard repo

1. Join the Slack!

Our #onboard channel is where the party is getting started! If you haven't already joined, make sure to add yourself to the channel. And for those who are new to the Hack Club slack, sign up to our community of 13k+ makers through here (don't worry, there isn't an application).

Perhaps ping a little hello to @Kevin Yang?

2. Upload to JLCPCB and Take a Screenshot

Upload your Gerber files to JLCPCB.com and add them to you cart. Once completed, take a screenshot with cost included!

Note: Your screenshot is VITAL since your project cannot be approved without it. You'll include the screenshot in your PR later.

3. Fork!

Fork the onboard repo! This is the where you'll add your project files and eventually PR from!

Fork the OnBoard repo

4. Add Your Design to Your Project Repo

From your fork of OnBoard, create a folder with your project name under OnBoard/projects. To do this, go to the projects folder and click Create new file.

Projects folder

Create new file

Then in the box labeled name your file..., type in PROJECT_NAME/README.md. This creates a README file under a folder called named after your project.

Creating a folder

After this, copy and paste the contents of TEMPLATE.md into the text editor and fill it out!

Paste in TEMPLATE.md

Once your done, press the big green Commit changes button to save!

With your README filled out, head over to add files to begin uploading your Gerber, design files, and screen shot of vendor approval.

Upload gerber files

In all, you should have the following files under your project folder:

  • README.md: A filled out TEMPLATE.md, renamed to README.md.
  • cart.png: A screen shot of your vendor approving your board.
  • Gerbers.zip: This should be the file that you send off to the vendor.
  • Design files(design.json, design.sch, design.brd, etc) in src folder . Whatever format your designer outputs to should be included.
  • Schematic.pdf: A pdf of your schematic, obtained from your designer.

If you have all the above, you're done with this step!

5. Create a PR!

Once you've uploaded your files, you can merge them to the main repo through a pull request! Under the contribute tab of your forked repo, click the big green Open pull request.

Open a PR

That will bring you to the main repo, where you'll initiate a pull request. All you need to do is to follow the checklist. Then, we'll review your PR, and you'll be off to the races! Submission checklist

6. Ship it!

Post photos of your board in #onboard! We can't wait to see what you make!

John sharing PCB

You finished the Jam.
Congratulations! 🎉 🎉 🎉
Share your final project with the community
Project Name
Project URL

Author

MaxWofford
Message on Slack

Outline