Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 5.3 KB

README.md

File metadata and controls

129 lines (88 loc) · 5.3 KB
Raw

Important

‼️ This is a work in progress. The current version of the kit is not ready for production use. ‼️

Eidolon Kit 🔮

GitHub License GitHub Actions Workflow Status GitHub Issues or Pull Requests GitHub last commit (branch) Commitizen friendly

Cover image

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

Apps

  • ponder a Ponder application for rapid API development on top of any EVM smart contract
  • web: a Next.js app for the web application

Packages

  • packages/config
    • @eidolonkit/env: a package for managing environment variables using T3 Env
    • @eidolonkit/tailwind: a Tailwind preset
    • @eidolonkit/tsconfig: tsconfig.jsons used throughout the monorepo
  • @eidolonkit/contracts: a Foundry project for smart contract development
  • @eidolonkit/ui: a component library for use in react based applications throughout the monorepo

Utilities

This Turborepo has some additional tools already setup for you:

  • TypeScript for static type checking
  • Foundry for smart contract development
  • Soldeer for package management for Foundry projects
  • Viem for connection to Ethereum through type-safe modules
  • Wagmi for connection to Ethereum through a collection of type safe react hooks
  • RainbowKit for wallet connection
  • Ponder for rapid API development on top of any EVM smart contract
  • Tanstack Query for asynchronous state management
  • Vocs for documentation site generation
  • Tailwind for styling
  • Park UI for scaffolding the ui component library package
  • React Testing Library for testing react components
  • Biome for code linting and formatting
  • Knip for finding unused files, dependencies and exports
  • Github Actions for CI/CD
  • Husky, Commitlint, and Lint-Staged for commit message and staged file linting
  • Renovate for keeping all dependencies up to date

Note

Prior to running any of the commands from Build or Develop, it is required to install all necessary dependencies and add appropriate environment variables.

Tip

With the current configuration, you will have to have an encrypted private key (even for local development with anvil) using the generated JSON keystores from cast wallet import --interactive. More details can be found here.

Install Dependencies

bun install && bun contracts:install

Add Environment Variables

  1. First, create a .env file in the packages/contracts directory and add the appropriate environment variables.
cp ./packages/contracts/.env.template ./packages/contracts/.env
  1. Next, create a .env.local file in the apps/web directory and add the appropriate environment variables.
cp ./apps/web/.env.local.template ./apps/web/.env.local

Build

To build all apps and packages, run the following command:

bun run build

Develop

To develop all apps and packages, do the following:

  1. In one terminal window, run:
bun anvil
  1. In another terminal window, run:
bun contracts:deploy
  1. Spin up remaining development servers:
bun dev

Tip

If you do not want the dev command to include spinning up the docs servers, you can update the dev script in the root package.json to turbo run dev

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

bunx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

bunx turbo link