Prerequisites
It is advised that your members have already completed
Boba Drops
or another
Web Dev YSWS, depending on their current level of understanding.
I would also recommend chatting to your school's IT department
beforehand to ensure your members can access everything they need to on
your academy devices or network. This will make your workshop run a lot
smoother!
- *.github.com
- *.github.dev
- *.hackclub.com
- *.vercel.app
- *.fillout.com
Creating a GitHub Organization for your Club
- Navigate to GitHub.com and log in to your account.
-
In the top right corner of your homepage, select the '+' menu and then
go to 'New organization'.
-
When asked to choose a plan, select 'Create a free organization'.
-
Fill out the information:
- Organization name: use the name of your school or Hack Club
-
Contact email: use the best email for GitHub to reach you about
your club
- This organization belongs to: select 'My personal account'
- Complete the CAPTCHA.
- Read and accept the GitHub Terms of Service.
- Click 'Next'.
-
When prompted to add organization members, you can click 'Skip this
step' for now.
Configuring your GitHub Organization (optional)
If you want to make your organization look a bit nicer, here are some
suggestions:
- Upload a profile picture
- Add a public email
- Add a short description
- Link to any social profiles you may have
-
Add a README to your organization
-
Create a new public repository in your organization called
'.github'.
-
Add a /profile/README.md to the '.github' repository. The README
will appear on your organization's profile, visible to anyone.
Setting up a Website
If your club doesn't already have a website...
-
Create a new repository in your club's organization, starting with the
Branch template.
-
Open up this new repo in your favourite IDE and fill in all the
placeholders. Make the website fit around your club!
-
Or, you could assign this task to your members (carry on reading).
-
Go to vercel.com and create a new project:
-
You may need to install Vercel onto your GitHub organization by
clicking 'Add GitHub Account'
-
Import your new website repository.
-
Give it a name and hit 'Deploy'!
- Your site is now live!
If your club already has a website...
That's great! Maybe take a look at our template and see how you could go
about implementing the members page?
Also, please could you ensure it is deployed, preferably with Vercel or
another host that allows you to preview the website on each pull
request.
Running a Workshop
Every member is required to add a personal page to the site, add a link
to it to the members page and contribute at least one other thing to the
site.
Adding Members to your GitHub Organization
-
Firstly, start by collecting all of your members GitHub
usernames/email addresses.
-
Head to your organization's homepage and click on the 'People' tab.
-
Using the 'Invite member' button, individually invite all of your club
members to the organization.
Make sure all members accept their invitations!
Assigning Tasks
Every member is required to contribute at least one other thing to the
site. We track these contributions through GitHub Issues. Members can
either come up with their own contributions and create an issue to track
them or leaders can create the issues and assign them to members based
on their skills/members can ask to claim particular issues.
Here are some ideas of tasks you could create:
- Filling out the placeholders & adding information to the site
- Adding more features like a blog or a sign up form
- Intentionally introduce bugs and have someone fix them
Questions?
Join
#branch
on the
Hack Club Slack.
DM
@Oliver
on Slack.
Email
branch@opott.uk.