hello friends! this is a ~ top-secret ~ project that has three key goals:
Eventually, matt's got bigger ideas - he'd love to showcase how awesome OSS is at UCLA!
We use the typical node project workflow, but with yarn. To run a local dev copy,
$ git clone https://github.com/uclaacm/opensource.git # or use ssh!
...
$ cd opensource
...
$ yarn install
...
$ yarn dev
...
This app is built with Next.js, a framework built on top of React. We enforce Typescript throughout the project, and have a strict linter with ESLint - enforced as a pre-commit hook with Husky and lint-staged. The CSS framework used is an alpha version WestwoodCSS, ACM Design's own CSS framework!
We bootstrapped this app with create-next-app
using the with-typescript-eslint-jest
template. There are some other goodies too, like Prettier and Jest (the latter we'd use more seriously in production).
This app is deployed on Netlify using their Next.js plugin; in particular, this let's us (kind of) take advantage of ISR.
Some small notes on how I've been writing the app so far:
uclaacm
org. So far, all of this is ISR'd :)util/types.ts
components/GitHubEventAction.tsx
is manually done (and currently, manually typed). I haven't really looked into it, but...
octokit
to flesh out the event types, instead of manually picking/resolving fieldsWant to give a quick shoutout to Bryan Pan of Creative Labs - he's been a big pusher of Next and a great friend to ACM!
This code is under the MIT License, so you can generally use it as you see fit (including forking, copying, etc.). I would love to know if you did - send matt an email at matt@matthewwang.me.