Skip to content

A clean, modern, accessible farewell website built with Vue 3, Vite, and Tailwind CSS to serve as a graceful closure for the Gauntlet Designs business.

Notifications You must be signed in to change notification settings

aftongauntlett/gauntlet-designs-vue

Repository files navigation

Gauntlet Designs - Farewell Website

Deploy Status CI/CD Pipeline Vercel Commit Activity Live Site

A clean, modern, accessible farewell website built with Vue 3, Vite, and Tailwind CSS to serve as a graceful closure for the Gauntlet Designs business.

Project Goals

This project serves as a professional closure page that:

  • Thanks past clients and acknowledges the business journey
  • Provides clear navigation to current professional presence
  • Promotes ongoing freelance services
  • Maintains high standards for performance, accessibility, and SEO
  • Demonstrates modern web development best practices

Tech Stack

Vue.js Vite TailwindCSS JavaScript

  • Vue 3 - Modern composition API with <script setup>
  • Vite - Lightning-fast build tool and dev server
  • Tailwind CSS - Utility-first CSS framework
  • CSS Custom Properties - Theme system with light/dark mode
  • Heroicons - Beautiful SVG icons
  • Responsive Design - Mobile-first approach

Project Structure

gauntlet-designs-vue/
├── public/
│   ├── .well-known/              # Well-known URIs for web standards
│   ├── favicon.svg               # Site favicon
│   ├── manifest.json             # Web app manifest
│   ├── robots.txt                # Search engine crawler instructions
│   └── sitemap.xml               # Site map for SEO
├── src/
│   ├── components/
│   │   ├── layout/
│   │   │   ├── AppHeader.vue     # Navigation and branding
│   │   │   └── AppFooter.vue     # Footer with copyright
│   │   ├── FloatingThemeToggle.vue # Theme switcher button
│   │   └── MainContent.vue       # Hero section and main content
│   ├── composables/
│   │   └── useTheme.js           # Theme management composable
│   ├── App.vue                   # Root component with layout
│   ├── index.css                 # Component styles with Tailwind
│   ├── main.js                   # Application entry point
│   └── theme.css                 # CSS custom properties for theming
├── deploy.sh                     # Deployment script
├── index.html                    # Main HTML template
├── jsconfig.json                 # JavaScript configuration
├── package.json                  # Project dependencies and scripts
├── postcss.config.js             # PostCSS configuration
├── tailwind.config.js            # Tailwind CSS configuration
├── vercel.json                   # Vercel deployment configuration
└── vite.config.js                # Vite build tool configuration

Development

Quick Start

# Clone the repository
git clone https://github.com/gauntletdesigns/gauntlet-designs-vue.git
cd gauntlet-designs-vue

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Deployment

⚠️ Important: This repository syncs to the production repository for Vercel deployment.

Development vs Production Repositories

  • Development repo: aftongauntlett/gauntlet-designs-vue (this repo)
  • Production repo: gauntletdesigns/gauntlet-designs-vue (Vercel watches this)

Deployment Methods

Option 1: Manual Deployment (Recommended)

# Deploy current main branch to production
npm run deploy

# Check deployment status
npm run deploy:check

Option 2: Using the Script Directly

# Make sure you're on main branch with committed changes
./deploy-production.sh

Option 3: Automatic via GitHub Actions (Optional)

  • Setup required: Add PRODUCTION_REPO_TOKEN secret in GitHub repository settings
  • Once configured: Pushes to main branch automatically sync to production repo
  • Current status: Manual deployment recommended (working perfectly)

Important Notes

  1. Only deploy from main branch - The script prevents accidental deployments from feature branches
  2. Commit changes first - Uncommitted changes will prevent deployment
  3. Production updates - Vercel only deploys when the gauntletdesigns org repo is updated
  4. Branch merges - When PRs are merged to main, run npm run deploy to update production

Vercel Configuration

The site deploys automatically to Vercel when the production repository is updated:

License

MIT License - Feel free to explore, learn from, and adapt the code for educational purposes.


Built with ✨ by Afton Gauntlett • Frontend Engineer specializing in UI/UX and Accessibility

About

A clean, modern, accessible farewell website built with Vue 3, Vite, and Tailwind CSS to serve as a graceful closure for the Gauntlet Designs business.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published