Skip to content

PreferredAI/PreferredAI.github.io

Repository files navigation

Preferred.AI Website

Quick Start (Development)

Option 1: GitHub Codespaces (No Local Setup!)

Open in GitHub Codespaces

  1. Click the button above (or go to repo → CodeCodespacesCreate codespace on main)
  2. Wait ~2-3 minutes for the environment to set up
  3. Run the dev server:
    pnpm dev
  4. A preview window will automatically open
  5. Edit files in content/posts/ and see live changes!
  6. Commit and push when done

Free Tier Limits:

  • GitHub Free: 120 core-hours/month (~60 hrs on 2-core machine)
  • GitHub Pro: 180 core-hours/month (~90 hrs on 2-core machine)
  • Auto-stops after 30 min idle (just close the tab when done!)
  • Check usage: github.com/settings/billing

Option 2: Local Development

pnpm install
pnpm dev

Visit http://localhost:3000

Creating a Blog Post

Via GitHub Codespaces (Cloud IDE - Preview Available)

  1. Open the project in Codespaces (see above)
  2. Create a new file in content/posts/ named your-post-title.md
  3. Copy content from .github/BLOG_POST_TEMPLATE.md
  4. Edit your post and preview live at port 3000
  5. Commit and push

Via GitHub Web Interface (No Installation Required - No Preview)

  1. Copy content from .github/BLOG_POST_TEMPLATE.md
  2. Go to content/posts/ on GitHub
  3. Click "Add file""Create new file"
  4. Name it: your-post-title.md (lowercase, hyphens)
  5. Paste the content from .github/BLOG_POST_TEMPLATE.md. Frontmatter should look like this:
    ---
    title: "Your Post Title"
    date: "2025-12-02"  # YYYY-MM-DD
    author: "Your Name"
    excerpt: "Brief summary (1-2 sentences)"
    featuredImage: "/uploads/2025/12/image.jpg"
    categories: ["Education"]  # "Presentation, "Travel, "Education", "Announcement", "Video", "Defense", "Publication", "Social"
    tags: []
    seoTitle: "Your Post Title - Preferred.AI"
    seoDescription: "Brief summary for SEO"
    ---
  6. Write your content in Markdown. Upload images to public/uploads/YYYY/MM/ first if needed.
  7. Commit to a new branch and create a Pull Request

Local Development (Requires Installation Locally - Preview Available)

  1. Ensure you have Node.js and pnpm installed.

  2. Clone the repository:

    git clone https://github.com/PreferredAI/PreferredAI.github.io.git
    cd PreferredAI.github.io
  3. Install dependencies:

    pnpm install
  4. Create a new Markdown file in content/posts/ using the template from .github/BLOG_POST_TEMPLATE.md.

  5. Start the development server:

    pnpm dev
  6. Open http://localhost:3000 to preview your post.

  7. Once satisfied, commit your changes to a new branch and push to GitHub. Create a Pull Request for review if needed.

Common Maintainance Tasks

Update Team Members

  • Edit name, image (path), title, link in src/data/team.tsx
  • Upload corresponding images to public/uploads/YYYY/MM/

Update Team Photos Slideshow

  • Edit photo details (path, date, location) in src/data/teamPhotos.ts
  • Upload corresponding images to public/team/

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published