Skip to content

icssc/weekly-graphic-creator

Repository files navigation

ICSSC Weekly Graphic Generator

Copy + paste Consortium Event messages and programmatically generate weekly graphics!

How to Use

  1. Navigate to the current deployment (https://icssc.link/create-weekly)
  2. Follow the on-screen instructions. This usually involves copy+pasting Discord messages, choosing background colors, and setting the graphic name.
  3. Click on the button to save the graphic (works best in Chromium-based browsers such as Brave), or use your browser's built-in screenshot tools (I like Arc's and Firefox's) to capture the graphic.

Setup/Running Locally

  1. Clone the repo
  2. bun install (you can probably also get away with npm or pnpm, but I used bun to create this project)
  3. bun run dev (or npm run dev or pnpm dev)
  4. Go to the URL logged in the console.

Adding Club Images

Club images are stored in public/club-logos/.

  • For consistency, all images are 312x312 or 312x228.

Club names are mapped to images by removing a @ UCI or at UCI suffix. For example:

  • ICSSC will look for icssc.png
  • AI@UCI will look for ai.png
  • AISUCI (no @) will look for aisuci.png

To add a club logo, simply add an image with size 312x312 or 312x228 to the public/club-logos folder.

  • Feel free to do this without running locally, though auto-deployments are not set up yet.

Development TODOs

  • Auto-deploy to GitHub pages since it's a static site
  • Pre-commit format hook
  • Add asset file size checks

Template: React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

React Compiler

The React Compiler is currently not compatible with SWC. See this issue for tracking the progress.

About

Tool to create weekly graphics for ICS clubs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors