README.md

Exactly Protocol

App - Twitter - Discord

Decentralizing the credit market, today.

Exactly Protocol is a decentralized, non-custodial and open-source protocol that provides an autonomous fixed and variable interest rate market enabling users to frictionlessly exchange the time value of their assets and completing the DeFi credit market.

Getting started

Clone the repository

git clone [email protected]:exactly/app.git

and install its dependencies with

bun install

Running the app locally

The app can be started locally with

bun dev

and the instance should be accessible at http://localhost:3000.

Development

An environment file is required to be created as .env in the root of the project with the following content

NEXT_PUBLIC_NETWORK=11155420  # Network to use by default

A development server can be started at http://localhost:3000 with

bun dev

Testing

We use Playwright testing framework to run our E2E tests and Tenderly to setup forks.

The following environment variables are required to be present for the tests to work as expected

TENDERLY_ACCESS_KEY=<tenderly access token>
TENDERLY_PROJECT=<tenderly project>
TENDERLY_USER=<tenderly user>

The full suite can be run using

bun start:e2e             # Or `bun dev:e2e` for a dev server

to start the app and in another terminal

bun run test

To run a single test use the same above but specifiy the spec to run with

bun run test -- [spec path] # e.g. e2e/specs/0-enter-exit-market/weth.spec.ts

Use the --headed flag to review the test running in the browser.

Deployment

We use Vercel. New pull requests will be deployed will receive previews deployed to be reviewed.

Any code merged to main will be immediately deployed to production.

License

Licensed under the BUSL-1.1 License.