NoMoreBadGift Website - Project Documentation Index

Project Overview

NoMoreBadGift Website is a Jekyll-based static marketing website for the NoMoreBadGift social gift-sharing mobile application. It serves as the primary web presence with product information, blog content, and app download links.

Quick Reference

Development Commands

# Start development server
cd nomorebadgift-website && bundle exec jekyll serve

# Install dependencies
cd nomorebadgift-website && bundle install

# Build for production
cd nomorebadgift-website && bundle exec jekyll build

Deployment

Architecture & Technology Stack

Core Technology

Key Dependencies

Site Structure & Content Architecture

Primary Pages

β”œβ”€β”€ index.md (home.html)     # Landing page with hero, features, recent posts
β”œβ”€β”€ about.md                 # Company story and mission
β”œβ”€β”€ contact.md              # Contact information and form
β”œβ”€β”€ terms.md                # Terms of service
└── privacy.md              # Privacy policy

Blog System

β”œβ”€β”€ blog/                   # Blog index page
β”œβ”€β”€ _posts/                # Individual blog posts (Markdown)
└── Collections:
    └── posts β†’ /blog/:year/:month/:day/:title/

Template Structure

_layouts/
β”œβ”€β”€ default.html           # Base template with header/footer
β”œβ”€β”€ home.html             # Landing page layout with hero section
└── post.html             # Blog post template

_includes/
β”œβ”€β”€ head.html             # Meta tags, SEO, and CSS includes
β”œβ”€β”€ header.html           # Site navigation and logo
└── footer.html           # Site footer with links and app badges

Asset Organization

assets/
β”œβ”€β”€ main.scss             # Custom SCSS styles with CSS variables
β”œβ”€β”€ images/               # Site images (logos, app mockups, badges)
β”‚   β”œβ”€β”€ logo.png
β”‚   β”œβ”€β”€ app-mockup.png
β”‚   β”œβ”€β”€ app-store-badge.png
β”‚   └── google-play-badge.png
└── README.md

Design System & Styling

CSS Architecture

Component Styles

Content Management

Site Configuration (_config.yml)

title: No More Bad Gift
description: The social gift-sharing app that helps you discover and share perfect gifts
baseurl: "/nomorebadgift-website"
url: "https://clairehjy.github.io"

# App store links (placeholder)
app_store_url: "#"
google_play_url: "#"

# SEO & Social
twitter_username: nomorebadgift
github_username: clairehjy

Blog Configuration

SEO & Meta

Deployment & CI/CD

GitHub Actions Workflow (.github/workflows/jekyll.yml)

Triggers: Push/PR to main branch
Build Environment: Ubuntu with Ruby 3.1
Build Process: 
  1. Checkout code
  2. Setup Ruby with bundle cache
  3. Configure GitHub Pages
  4. Build Jekyll with production baseurl
  5. Upload build artifacts
  6. Deploy to GitHub Pages

Deployment Configuration

Development Guidelines

Content Creation

  1. Blog Posts: Create in _posts/ with YYYY-MM-DD-title.md format
  2. Pages: Create in root with YAML front matter
  3. Images: Add to assets/images/ and reference with relative_url filter
  4. Styling: Modify assets/main.scss for custom styles

Local Development

  1. Install Ruby 3.1 and Bundler
  2. Run bundle install to install dependencies
  3. Start server with bundle exec jekyll serve
  4. Site available at http://localhost:4000

Code Standards

Integration Points

Mobile App Integration

Analytics & Tracking

Content Strategy

File Reference

Critical Configuration Files

Template Files

Documentation