Skip to content

UoaWDCC/web3

 
 

Repository files navigation

WEB3UOA 🚀

University of Auckland's premier Web3 and blockchain community

TypeScript React Vite Tailwind CSS

Welcome to the official website repository for WEB3UOA - exploring the decentralised future through blockchain technology, smart contracts, and Web3 innovation.

✨ Features

  • 🎨 Modern UI - Built with React 19 and Tailwind CSS v4
  • 🎯 TypeScript - Fully typed for better developer experience
  • Fast Development - Powered by Vite with HMR
  • 📱 Responsive Design - Mobile-first approach with seamless tablet and desktop layouts
  • 🌙 Dark Theme - Beautiful purple, blue, and cyan accent colors
  • Smooth Animations - Parallax scrolling and blur effects
  • 🧩 Component Library - Built with Radix UI primitives
  • 🎭 Lucide Icons - Beautiful, consistent iconography

🚀 Quick Start

Prerequisites

  • Bun (recommended) or Node.js 20.19+
  • Git

Installation

# Clone the repository
git clone https://github.com/ck0x/web3uoa.git
cd web3uoa

# Install dependencies
bun install

# Start development server
bun dev

The site will be available at http://localhost:5173

Build for Production

# Create optimised production build
bun run build

# Preview production build locally
bun run preview

📁 Project Structure

web3uoa/
├── src/
│   ├── components/          # React components
│   │   ├── ui/             # Reusable UI components
│   │   │   └── button.tsx  # Button component with variants
│   │   ├── hero.tsx        # Hero section with parallax
│   │   ├── about.tsx       # Features section
│   │   ├── sponsors.tsx    # Sponsors showcase
│   │   └── footer.tsx      # Footer with social links
│   ├── lib/
│   │   └── utils.ts        # Utility functions
│   ├── App.tsx             # Main application component
│   ├── main.tsx            # Application entry point
│   └── index.css           # Global styles and Tailwind
├── public/                  # Static assets
├── index.html              # HTML template
└── vite.config.ts          # Vite configuration

🎨 Tech Stack

Core

Styling

  • Tailwind CSS v4 - Utility-first CSS framework
  • tw-animate-css - Animation utilities
  • Custom Design System - Dark theme with purple/blue/cyan accents

UI Components

🎯 Key Sections

Hero Section

  • Parallax scrolling background
  • Dynamic blur effect on scroll
  • Call-to-action buttons
  • Social media links

About Section

  • Feature cards showcasing club benefits:
    • Learn & Build - Hands-on workshops
    • Community - Connect with like-minded students
    • Opportunities - Internships and hackathons

Sponsors Section

  • Placeholder for 2026 partnerships
  • Contact form for interested sponsors

Footer

  • Quick navigation links
  • Social media integration
  • Contact information

🔗 Links

🛠️ Development

Available Scripts

# Development server
bun dev

# Type checking
bun run tsc -b

# Build for production
bun run build

# Preview production build
bun run preview

# Lint code
bun run lint

Code Style

  • Uses ESLint for code quality
  • TypeScript strict mode enabled
  • React Compiler enabled for optimisation
  • Follows React best practices

🌏 Localisation

The site uses New Zealand English spelling:

  • "decentralised" (not "decentralized")
  • "finalising" (not "finalizing")
  • "organisation" (not "organization")

📝 License

© 2025 WEB3UOA. All rights reserved.

🤝 Contributing

We welcome contributions! If you'd like to help improve the website:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

💬 Contact

Have questions or want to get involved?


Built with ❤️ by the WEB3UOA team

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 84.2%
  • CSS 9.4%
  • JavaScript 3.3%
  • HTML 3.1%