SHRINKsign in

← all guides

04 / 08

shipping it

Checklist before you ship!

Make sure you've done all of these before you ship!

  1. you've verified your identity with Hack Club
  2. your Hack Club account has an address
  3. the Hackatime projects you pick on the ship form add up to at least 30 minutes
  4. the app doesn't load anything from the internet
  5. your repo is public (any git host works)
  6. the repo has a README that explains the app
  7. the readable code for the project is in the repo

Then a reviewer tries your project, and reads the README and the code.

requirements in your repo

This isn't a strict requirement, however it's very much recommended to have these (or a varient of these) in your repo.

  • src/index.html The source file, this SHOULD NOT be one lined!
  • build.mjs and package.json
  • dist/uri.txt, so people can try the project
  • README.md

the README

Be clear on what your project is, it's EXTREMELY important for it to be human written! We know how an AI readme sounds like and we'll reject your project over it.

You could lay it out like this:

README.md
# name of your project

Explaion your project.

## how to use it


## how it works

## building
```
npm install
node build.mjs
```

A screenshot or GIF of it would be nice too :D

badges

  • canvas: drawn with the Canvas API
  • web audio: makes sound with the Web Audio API
  • interactive: responds to the keyboard, mouse or touch
  • 3D: shows something in 3D

Please be honest and only select those that you implamented in your project! Our reviewers will be strict on this.