Skip to content

splinefi/spline

Repository files navigation

Spline

IMPORTANT: This project is a work in progress and is not yet stable.

L2-native aggregator for L1 yield.

Development

We use pnpm for monorepo management.

If you don't yet have pnpm, you can install it with the following command:

npx pnpm add -g pnpm

Then, install the project dependencies:

npx pnpm i

Front-end

Run front-end locally, by default on http://localhost:3000

npx pnpm run ui:dev

Build static files

npx pnpm run ui:build

Locally preview build directory (if it exists)

npx pnpm run ui:preview

Cloudflare Pages

This repository is synced with Cloudflare Pages, and the latest build is always available on https://spline.pages.dev within a few minutes after each commit.

It sees /ui as the root path and src/build as the output directory.

It uses Node 12.22.1 and NPM 7.16.0.

Each time a commit is made to master, it runs the following command, which takes around 3-5 minutes:

npx pnpm add -g pnpm && npx pnpm i && npx pnpm run build

Users and contributors do not need to run the above command.

Linting

We use ESLint and Prettier for linting.

npx pnpm run lint

You must lint before opening a PR, though Husky should do this automatically.

License

GNU GPLv3