Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (40 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 1.81 KB
Raw

How to contribute to the project?

Install

Make sure to have installed:

  • Node > 16
  • Git
  • Pnpm
git clone git@github.com:lyonjs/lyonjs.github.com.git

pnpm install

Some useful commands

  • pnpm build, build next output of the website and run eslint
  • pnpm fmt, format all files with prettier
  • pnpm fmt:check, check format all files with prettier
  • pnpm dev, start a local dev server on port 3000
  • pnpm export, export the website as static html file
  • pnpm e2e, run e2e test with Playwright

Husky git hooks

We use husky to install and handle git hooks on pre-commit to pre-run lint and format on files before even pushing them on github. Normally, they should be installed with the first pnpm install

Architecture of data used in the app

flowchart LR
  A[Meetup GraphQL API]-->|fetch events| E[Enhance Event data]
  subgraph Internal Website data
  C[Sponsors] --> B
  D[Organisators] -->B
  E-->B[Next Static props]
  end
Loading

Deployment

The site is deployed by Vercel through its GitHub integration: every PR gets a preview deployment, and master is deployed to production.

Docker image

The CI pipeline (.github/workflows/integration.yml) still builds the Docker image (Dockerfile) on every push and PR, to make sure the app can be self-hosted:

  • Pull requests: the image is built but not pushed.
  • master: the image is pushed to the GitHub Container Registry (ghcr.io/lyonjs/lyonjs.github.com) with the latest and commit SHA tags.

How to?

How to enhance content of past events?

If you need to add sponsors, videos, descriptions, speakers to a passed or programmed event, you sadly have to add it manually in a file. In data-override.ts, you can override each event by absolute url and override some informations.