Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 3.05 KB

README.md

File metadata and controls

41 lines (26 loc) · 3.05 KB
Raw

@hackclub/hcb-wrapped-2024

This repository houses the React component that will be used to generate this year's hcb.hackclub.com/wrapped. It also contains a Next.js site used for testing (currently deployed at hcb-wrapped-2024.hackclub.dev).

Directory

Contributing

We'd love you help making HCB Wrapped incredible! We plan to launch Wrapped on the 18th of December. To make that happen, we've got to design a dozen or so "slides" by December 15th. Each slide will feature different pieces of data about how the user used HCB over the past year.

Everything we have in mind is mapped out in #1. If something peaks your interest, feel free to self-assign it! If you have an idea for a slide that isn't listed, feel free to open an issue. We'll discuss what you have in mind, and if it's a good fit, we'll add it to the list!

When it comes to testing data, you've got two options:

  • Download you personal test data (test.json) from hcb.hackclub.com/wrapped/data and place it in your root directory (don't worry, we've git-ignored all test.json files!).
  • Use randomly generated test data, this is enabled be default (delete your test.json to go back to using it).

To create a slide:

  • Copy the template in components/Wrapped/slides/TemplateSlide.tsx.
  • Add your slide to the array exported by components/Wrapped/slides.ts.
  • Start designing! You can take inspiration from last year's Wrapped.
    • You'll have access to the entire data object in your component. It'll conform to the type defined in components/Wrapped/utils/data.ts.
    • We're using the $ theme utility; it provides shorthands for including classes and variables from hackclub.css/
      • Here's an example where the .title and .eyebrow classes are applied to the element as well as some additional styling 
        <h2 {...$.title.eyebrow({ fontWeight: 800 })}>{data}</h2>
      • To access a variable just do $.var, for example $.s1 for var(--spacing-1) or $.cyan for var(--cyan).

If at any point, you need help, drop a message in #hcb-internals and we'll (Ian, Gary & Sam) do everything we can to help out. If you feel like you need additional data for your slide to be great, let us know and we'll get you that data.

Motivation for Structure

HCB is closed source, however, we wanted to open source the wrapped page as we did last year while also having access to private data. Hence, this setup.