← Course Home
Guide · about 15 minutes
Project guide

Set Up GitHub for Your Project

Your final project lives in a public GitHub repository in your own account. It stays yours after the course, and you can show it to universities and employers.

Create your free GitHub account

  1. Go to github.com/signup.
  2. Use an email address you will keep after school or work changes. You will need it to sign in.
  3. Choose a username you are happy to show on a CV, for example your name. It appears in your project link.
  4. Enter the code GitHub emails you to confirm the address.
GitHub accounts are free. GitHub requires you to be at least 13 years old. Turning on two-factor authentication (Settings, then Password and authentication) protects your work.

Create your project repository

  1. Signed in to GitHub, click + at the top right, then New repository.
  2. Name it after your project, for example flu-sentinel-agent. Add a one-line description.
  3. Choose Public. The course reads public repositories only, and a private one cannot be checked.
  4. Turn on Add README. For .gitignore, choose Python for Track C or Node for Track B. Track A can leave it empty.
  5. Click Create repository, then copy its address from the browser, for example github.com/your-name/flu-sentinel-agent.
Working in a team? One person creates the repository, then adds the others under Settings, then Collaborators, so everyone can upload their part. Every member adds the same link in the course.

Add the README and ethics review templates

Two templates give you the structure the course asks for: the six README sections from Lesson 6.2 and the four-part ethics review from Lesson 8.2.

⬇ README template⬇ Ethics review template
  1. In your repository, open README.md, click the pencil icon, replace everything with the README template, then click Commit changes.
  2. Click Add file, then Create new file. Name it ethics-review.md, paste the ethics review template and commit.
  3. Fill both in as you build. Text inside <!-- --> markers is guidance: it is hidden on GitHub and does not count towards the word minimums.

Add your Student ID

Your Student ID is shown in the project box in Lesson 4.4 when you are logged in, for example BIO-2026-1A2B3C4D. Write it in the Team section of your README, on a normal line, not inside the guidance markers.

Only someone who can edit the repository can add it, so it shows the project is yours. In a team, every member adds their own ID.

Upload your project files

  1. Click Add file, then Upload files, drag in your files or folders, and click Commit changes.
  2. Track A: export your Make or n8n workflow as a JSON file and upload it, with screenshots if they help explain it.
  3. Tracks B and C: upload your code, or push it from VS Code. The Course Closing lesson has a video for each method.
Never upload your .envfile or any API key. Anything in a public repository can be read by anyone. If a key was uploaded by mistake, delete it in your provider's dashboard and create a new one.
Watch: uploading files and folders to GitHub (8 min)

Add your demo video

Record 2 to 5 minutes showing your agent working with real input. Then either:

  1. Link it (recommended): upload it to YouTube as Unlisted, or to Google Drive shared with "Anyone with the link", Loom or Vimeo, and paste the link in the Demo section of your README.
  2. Or upload the file to the repository with Add file, then Upload files. GitHub's upload page accepts files up to 25 MB, so a longer recording works better as a link.

Share your repository link

  1. Open Lesson 4.4 and paste your repository link into the project box.
  2. Keep building in the same repository through the course.
  3. In the Course Closing lesson, press Submit for certificate. The check tells you if anything is missing, and you can resubmit after fixing it.
What the check looks for
  • A public repository with your project files (code, workflow export or configuration)
  • README.md with at least 400 words, and your Student ID in it
  • ethics-review.md with at least 150 words
  • A demo video in the repository, or linked in the README

Following the course through a school or university programme? Your team hands in its project through the programme console at the end of Lesson 4.4 and Course Closing, as your teachers explain.

Stuck? Ask in the question box at the end of any lesson. The bioERGOtech team will reply.