Skip to content

README.md

Latest commit

 

History

History
49 lines (27 loc) · 2.66 KB

README.md

File metadata and controls

49 lines (27 loc) · 2.66 KB

L2BEAT 💓

L2BEAT (Layer 2 Beat) is a website dedicated to providing research and statistics about the very exciting layer 2 technology on Ethereum.

You can visit the site yourself at https://www.l2beat.com/.

Scripts

Coolify: check environment variables

scripts/coolify/check-env.ts lists every application on your Coolify instance (via the HTTP API) and checks whether each one defines a given environment variable by key (exact match). Output uses project/environment/application labels when project and environment metadata are available.

It is especially handy when you are changing, rotating, or cleaning up a variable and you are not sure which application still uses it—before you had to click through Coolify apps by hand; this script checks all of them in one run.

From the repository root:

pnpm coolify:check-env SOME_ENV_VAR

Configuration

  • Loads dotenv from the repo root .env if present.
  • COOLIFY_API_KEY (required): Coolify API token (Keys & Tokens → API tokens). Pass with --api-key or set in .env / the environment.
  • COOLIFY_SERVER (optional): Coolify base URL. Defaults to https://coolify.l2beat.com; override with --server / -s or COOLIFY_SERVER.

Run pnpm coolify:check-env --help for full CLI options.

Contributing

We welcome and encourage contributions. To learn about the project structure and contributions please read CONTRIBUTING.md.

🔍 Here is also a visual step-by-step guide for creating a Pull Request - link

License

We believe in knowledge sharing and open access. Our code is and will remain open source with the permissive MIT license.

Versioning and publishing (tooling)

Some of the sub-packages are published to NPM. We use a tool called changesets to manage versioning, cross-dependency versioning and publishing new versions to NPM. When you make a change, before merging to main:

  • run pnpm changeset and mark the packages you wish to publish, select what kind of a change it is (major,minor,patch) and provide the summary of the changes

When you want to publish all previous changes to NPM:

  • now run pnpm changeset version, this will change the generated .changeset/file.md into an entry into CHANGELOG.md and package.json in changed packages

After your PR with changed CHANGELOG.md and package.json is merged into main, a CI step will run which will try to publish all changes.