AI/ML Cohort 2510: Capstone Projects

A community-maintained showcase of student capstone projects. The site is automatically built from YAML files and deployed to GitHub Pages whenever a pull request is merged into main.

Live site: https://fullstackacademy.github.io/2510-capstones

---

How to add your project

1. Fork this repository using the Fork button on GitHub.

2. Clone your fork locally or open it in a Codespace:

   git clone https://github.com/your-username/2510-capstones.git

3. Copy projects/_template.yml to a new file in the same folder, named after yourself:

   projects/firstname-lastname-capstone.yml
   

   Use lowercase letters and hyphens, no spaces.

4. Fill in your project details. Only title and student are required; everything else is optional but encouraged.

5. Add images (optional) to the repo root folders, named after yourself with hyphens:

   headshots/firstname-lastname-headshot.png
   screenshots/firstname-lastname-screenshot.png
   

   The build script picks them up automatically; no YAML changes needed.

6. Open a pull request from your fork back to main on this repo.

7. Once merged, your project appears on the live site within a minute or two.

YAML fields

Field	Required	Description
title	✅	Your project name
student	✅	Your full name
tagline		One-sentence summary shown on the list page
description		Paragraph(s) shown on the detail page
repo		Link to your GitHub repository
demo		Link to a live demo / deployed app
tags		List of technology tags, e.g. [React, PostgreSQL]

---

Local development

npm install
npm run build        # generates the site in docs/
open docs/index.html # view locally

The build script reads every .yml file in projects/ (ignoring _template.yml) and writes static HTML to docs/.

---

Deployment

GitHub Actions builds and deploys the site on every push to main. The workflow file is at .github/workflows/deploy.yml.

You need to enable GitHub Pages in the repository settings: Settings → Pages → Source → GitHub Actions