/epm-api

Deploy and manage EIP-2535 Diamond Proxy contracts

Primary LanguageTypeScriptMIT LicenseMIT

EPM Logo

Ethereum Package Manager

CircleCI

What is EPM?

EPM lets you deploy and compose smart contracts. It leans heavily into providing functionality for EIP-2535 Diamond Standard contracts.

For a more detailed intro see Introducing Ethereum Package Manager (EPM).

Installation

  1. Install node modules: yarn
  2. Copy the .env.example file to .env and fill out required environment variables
  3. Run it: yarn local
  4. Navigate to http://localhost:3005

Code style

CI will fail if the code does not lint. You can check this from the CLI with:

yarn lint

You can also auto-fix issues with:

yarn lint:fix

It's recommended you use VSCode with these extensions for the best IDE support:

ESLint

Prettier - Code formatter

Branches / Deployment

master is the main development branch. This is also the branch PRs should be submitted against.

Each branch corresponds to an environment that will be automatically updated via CI:

master - https://api.epm.wtf

Repositories

Frontend: https://github.com/kengoldfarb/epm/

Backend: https://github.com/kengoldfarb/epm-api/