Skip to content

e-choness/bubble-up-website

Repository files navigation

Bubble UP! Website

A playful, animated Website designed for the Bubble UP! game website. Features modern animations, responsive design, and a bubbly aesthetic that brings joy to visitors.

🚀 Features

  • Modern Design: Clean, playful interface with bubble animations
  • Fully Responsive: Optimized for all devices and screen sizes
  • GSAP Animations: Smooth, professional animations throughout
  • Jekyll Collections: Easy content management for announcements and team
  • Multi-platform Downloads: Support for all major platforms
  • Social Integration: Complete social media integration
  • SEO Optimized: Built-in SEO best practices
  • Performance Focused: Optimized for fast loading times

🛠️ Installation

  1. Clone this repository:
git clone https://github.com/e-choness/bubble-up-website.git
cd bubbleup-jekyll-theme
  1. Install dependencies:
bundle install
  1. Build and serve the site:
bundle exec jekyll serve
  1. Visit http://localhost:4000 to see your site!

📁 Structure

bubble-up-website/
├── _config.yml          # Site configuration
├── _data/               # Data files
├── _includes/           # Reusable components
│   ├── sections/        # Page sections
│   └── footer.html      # Site footer
├── _layouts/            # Page layouts
├── _pages/              # Static pages
├── _posts/              # Blog posts
├── _announcements/      # Game announcements
├── _team/               # Team member profiles
├── assets/
│   ├── css/
│   ├── js/
│   │   ├── main.js      # Main functionality
│   │   └── animations.js # GSAP animations
│   ├── images/
│   └── scss/            # Sass stylesheets
└── README.md

⚙️ Configuration

Site Settings

Edit _config.yml to customize:

  • Site title and description
  • Social media links
  • Download links for different platforms
  • Contact information

Colors and Styling

Update assets/scss/_variables.scss to customize:

  • Color palette
  • Typography
  • Spacing and layout
  • Animation timings

Content Management

Announcements

Create new announcement files in _announcements/:

---
title: "Your Announcement Title"
date: 2024-01-15
image: "/assets/images/announcements/your-image.jpg"
excerpt: "Brief description of the announcement"
---
Your announcement content here...

Team Members

Add team members in _team/:

---
name: "Team Member Name"
title: "Their Role"
avatar: "/assets/images/team/avatar.jpg"
social:
  linkedin: "https://linkedin.com/in/username"
  twitter: "https://twitter.com/username"
---
Team member bio...

🎨 Customization

Adding New Sections

  1. Create a new section file in _includes/sections/
  2. Add corresponding SCSS in assets/scss/sections/
  3. Include the section in your page layout
  4. Add animations in assets/js/animations.js

Modifying Animations

Edit assets/js/animations.js to:

  • Adjust animation timings
  • Add new scroll triggers
  • Customize hover effects
  • Create new bubble effects

Styling Changes

Update SCSS files in assets/scss/:

  • _variables.scss for colors and fonts
  • components/ for UI components
  • sections/ for page sections
  • _base.scss for global styles

📱 Responsive Design

The theme is fully responsive with breakpoints:

  • Mobile: < 640px
  • Tablet: 640px - 1024px
  • Desktop: 1024px+

🔧 Development

Prerequisites

  • Ruby 2.7+
  • Jekyll 4.3+
  • Node.js (for asset compilation)

Local Development

# Install dependencies
bundle install

# Serve with live reload
bundle exec jekyll serve --livereload

# Build for production
JEKYLL_ENV=production bundle exec jekyll build

Asset Compilation

SCSS files are automatically compiled by Jekyll. For JavaScript:

  • main.js handles core functionality
  • animations.js manages GSAP animations
  • Both are included in the default layout

🚀 Deployment

GitHub Pages

  1. Push to your GitHub repository
  2. Enable GitHub Pages in repository settings
  3. Select source branch (usually main)

Netlify

  1. Connect your repository to Netlify
  2. Set build command: bundle exec jekyll build
  3. Set publish directory: _site

Custom Server

Build the site and upload the _site directory:

JEKYLL_ENV=production bundle exec jekyll build

🎮 Game Integration

Download Links

Update download URLs in _config.yml:

download_links:
  android: "your-play-store-url"
  ios: "your-app-store-url"
  windows: "your-windows-download"
  mac: "your-mac-download"
  linux: "your-linux-download"

Analytics

Add your analytics tracking code to _includes/head.html or use Jekyll plugins.

📄 License

This theme is open source and available under the MIT License.

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

📞 Support

For questions or issues:

  • Create an issue on GitHub
  • Check the documentation
  • Contact the development team

🙏 Credits

  • GSAP: Animation library
  • Jekyll: Static site generator
  • Sass: CSS preprocessing
  • Google Fonts: Typography (Poppins)

Built with ❤️ for the Bubble UP! community

About

Welcome to Bubble UP! official website

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors