olympus-contracts

(β˜… 720)

No description available.

  • .dapprc
  • .dockerignore
  • .editorconfig
  • .env.example
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .gitpod.yml
  • .markdownlint.json
  • .node-version
  • .nvmrc
  • .prettierignore
  • .prettierrc
  • .solhint.json
  • .solhintignore
  • .trivyignore
  • AGENTS.md
  • biome.json
  • Dockerfile
  • hardhat.config.ts
  • LICENSE
  • Makefile
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • shell.nix
  • tsconfig.json

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/OlympusDAO/olympus-contracts

Downloads the entire project code from GitHub to your computer.

cd olympus-contracts

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t olympus-contracts .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 olympus-contracts

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn install

Downloads and installs the libraries listed in package.json.

yarn compile

Type this command into your terminal and run it.

yarn compile --no-typechain

Type this command into your terminal and run it.

yarn typechain

Type this command into your terminal and run it.

yarn run start

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make run

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation