-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Summary
We need a reusable React-based NPM package (blt-hackathon) that renders the full Hackathon interface using a simple config object. This will allow any project or organization to install the package, pass a config, and instantly display a hackathon page with leaderboard, repo stats, and other features.
Proposed Features
-
Provide a main component:
<BLTHackathon config={...} />
-
Accept a clean TypeScript config interface
-
Render hackathon information (name, rules, timeline, sponsors, prizes)
-
Render Review Leaderboard
-
Render Repo Stats (optional via config)
-
Use TailwindCSS for styling (precompiled → shipped as
dist/styles.css) -
Allow users to import styles via:
import "blt-hackathon/dist/styles.css";
Technical Implementation
-
Build with TypeScript + tsup
-
Use Tailwind v4 internally to generate the final CSS bundle
-
Export ESM + CJS builds +
.d.tstypes -
Keep API usage minimal and config-driven
-
Expose only one public API:
export { BLTHackathon }; export type { HackathonConfig };
Goal
Create a lightweight, plug-and-play React component library for Hackathons that is easy to install, easy to configure, and easy to use in any frontend project.