Skip to content

heli-t-00/december-hackathon

 
 

Repository files navigation

🎅✨ Baby, It's Code Outside! 🎄🎁

🎄 December Hackathon: Hack the Holidays

wireframe - home

Deployment

  • 🎁The project is deployed Click here to play!

🎅 TABLE OF CONTENTS

Section
Project description, link, etc.
Typography
Features
UX / UI
Testing
Unfixed Bugs
Deployment
Credits
Future Features

🌟 FEATURES

  • 🎁 Header

    • Contains the navigation links to change from page to page.
  • 🎁 Team page

    • This page shows the team of individuals who collaborated together to make this game.
  • 🎁 Gameplay

    • All mini games will be different and fun, while also relating to christmas theme
  • 🎁 How to play

    • Instructions to help users understand what they must do in order to complete the game

🎄 Criteria

  • 🎁 The project fits the theme of celebrating the holidays.
    The "12 Days of Christmas" is the period in Christian theology that marks the span between the birth of Christ and the coming of the three wise men. It begins on Christmas and runs to the Epiphany (6th January). We have decided to celebrate the "12 Days of Code-mas!"

  • 🎁 The project is well planned and executed (Using GitHub Projects/Kanban). We utilised a project board on GitHub in order to plan our tasks and stay organised with the project. We also communicated well on Slack throughout the Hackathon time period.

  • 🎁 The project has a basic README that follows the provided template. Please refer to the current README.

  • 🎁 The project has an overall sense of completeness.
    We are happy with the project we have produced. We have a homepage (index.html) with Bootstrap cards which lead to different holiday themed animations and interactive games to get you into the holiday spirit!

  • 🎁 The project showcases a strong sense of creativity and originality.
    Each team member was responsible for two days and were delighted by the opportunity to showcase our individual creative thoughts and ideas. We showcased our ideas regularly on Slack and were very supportive of each other. We think that the 12 Days of Code-mas is an original idea as most people don't realise that the 12 days begins on Christmas day - we are not an Advent Calendar!


🎅 About the Submission

Intro

When you enter our site, you are greeted with twelve cards: 1 - 12. Behind each day is a different holiday based animation or interactive task. The idea is that each day represents the "12 days of Code-mas". Come back each day for holiday fun!


Goal

  • 🎄 Problem Statement: Once it gets to Christmas, people can get a bit blue that it's all over but the 12 Days of Code-mas extends the joy until the Epiphany! (6th January)
  • 🎄 Objective(s): Our project aims to bring festive joy to people over the festive period.
  • 🎄 Target Audience: Any age group can appreciate the 12 Days of Code-mas. Young children would probably need some assistance from an adult with the games.
  • 🎄 Benefits: The games are replayable so you can return as often as you like to feel holiday joy! The animations are bright and cheerful - perfect for if you are sitting at your desk and want a pick-me up!

💻 Tech Stack

  • JS: the primary language used to develop interactive components of the website.
  • HTML: the markup language used to create the website.
  • CSS: the styling language used to style the website.
  • GitHub: used to host the website's source code.
  • Chrome DevTools: was used to debug the website.
  • Font Awesome: was used to create the icons used on the website.
  • BootStrap: was used to create responsive elements.
  • Canva: was used to generate/ design images and cards

🎄TYPOGRAPHY

  • The font for the website were imported using Google Fonts. The Merienda font has a cursive and slightly whimsical style, which is perfect for creating a fun, informal, and engaging atmosphere—ideal for a surprise calendar website.
  • The background images, images and the emojies were either from google or desigend featruing Christmas theme.

🎅✨UX/UI SECTION

Project Goals and Desgin choices:

🌟 USER STORIES:

  • As a curious user, I want to click on a calendar box and unlock a surprise (e.g., a game, song, or message), so that I can experience excitement and fun daily.
  • As a music lover, I want some calendar surprises to feature songs, playlists, or musical snippets, so I can discover new music or enjoy a favorite tune.
  • As a gamer, I want some surprises to unlock fun mini-games that I can play instantly, so I can take a quick break and relax.
  • As a knowledge seeker, I want some surprises to reveal trivia, puzzles, or fun facts, so I can learn something new while engaging with the calendar.
  • As a returning user, I want the surprises to vary every day, so the experience remains fresh and exciting for me over time.

🎁 WIREFRAMES:

Page screenshot Page screenshot
Home page wireframe - home mobile wireframe - mobile
Team page wireframe - team

💻 TESTING

Testing can be found here

🌟 Unfixed Bugs

  • Day 4 html file is not responsive.

** 💻DEPLOYMENT**

The project was developed in Gitpod, committed and push to GitHub through using the terminal section in Gitpod. To deploy this page to GitHub pages from its GitHub repository, the following steps were taken:

  1. Log into GitHub
  2. From the list of repositories on the screen, select the relevant repository
  3. From the menu list near the top below the project name, select settings
  4. There will be a nav down the left of the screen. Find pages and select it when found
  5. Select the branch dropdown which will say none and change it to main
  6. Click the save button to the right of it

How to run this project locally:

  1. To clone this project into Gitpod you will need a GitHub account
  2. Use the Chrome browser

Then follow the steps:

  1. Install Gitpod Browser Extensions for Chrome
  2. After installation, restart the browser
  3. Log into Gitpod with your Gitpod account
  4. Navigate to the project GitHub repository
  5. Click the green 'Gitpod' button in the top right corner of the repository
  6. This will trigger a new Gitpod workspace to be created from the code in GitHub where you can work locally

🎄Credits

Media:


🎁FUTURE FEATURES

  • Add extra rooms
  • Add leaderboards
  • Add mobile and tablet functionality.

About

Baby its Code Outside!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 42.6%
  • CSS 29.8%
  • JavaScript 27.6%