Skip to content

Repository files navigation

AI Builders — Website

A startup-style landing page for the AI Builders GitHub organization, built with TypeScript + React (Vite), CSS, MDX, and TeX (via KaTeX).

All copy on this site is taken directly from the team's actual README (github.com/AI-Builders-Iran) — About, Vision, Mission, domains, tech stack, the 12-stage engineering workflow, culture, contribution guide, community stats, and real contact links (GitHub, LinkedIn, Telegram, email). The README does not list individual repositories or member names — it links out to a separate TEAM.md — so this site links to that page rather than inventing a project list or team roster.

Run locally

npm install
npm run dev

Deploy to GitHub Pages (automated with GitHub Actions)

  1. Create a new repository, e.g. ai-builders-iran-site, and push this project to it:

    git init
    git add .
    git commit -m "init site"
    git branch -M main
    git remote add origin https://github.com/AI-Builders-Iran/ai-builders-iran-site.git
    git push -u origin main
  2. In vite.config.ts, set REPO_NAME to match the repository name exactly (currently ai-builders-iran-site). If you instead want the site at the org's root domain ai-builders-iran.github.io, name the repo exactly that and set base to "/".

  3. In the repo, go to Settings → Pages → Build and deployment → Source and select GitHub Actions.

  4. On every push to main, .github/workflows/deploy.yml will automatically:

    • install dependencies (npm ci)
    • build the project (npm run build)
    • publish the dist folder to GitHub Pages

    The site will then be live at: https://ai-builders-iran.github.io/ai-builders-iran-site/

Project structure

src/
  components/     Nav, Hero, About, Domains, TechStack, Workflow,
                   GetInvolved, Stats, TeamCta, Footer
  content/        Note.mdx — MDX page demonstrating TeX/KaTeX rendering
  data/           content.ts — all site copy, sourced from the README
  styles/         global.css — design tokens and layout
.github/workflows/deploy.yml   GitHub Pages CI/CD

Updating content

Everything the site displays lives in src/data/content.ts. If the README changes, update that file — nothing else needs touching.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages