Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 3.04 KB

README.md

File metadata and controls

113 lines (71 loc) · 3.04 KB
Raw

License

This project is licensed under the BSD 3-Clause License with Specific Usage Restrictions.

Key Terms

  • Permitted Use: This software may only be used to develop applications (frontend or backend) that directly interface with the Merkl incentive distribution solution.
  • Prohibited Uses:
    • Developing standalone applications unrelated to the original backend.
    • Creating competitive backend services or applications.
    • Reverse engineering the core backend logic.
    • Developing alternative backend implementations.
  • Commercial Use: Commercial use of this software, including incorporating it into paid products or services, is strictly prohibited without prior written approval from Angle Labs, Inc. For inquiries regarding commercial use, contact [email protected]

Full License

For detailed terms and conditions, refer to the LICENSE file in this repository.

Welcome to Merkl Lite !

Prerequisites

Installation

  1. Go to cd packages/dappkit
  2. git submodule init
  3. git submodule update
  4. bun i
  5. cd ../..
  6. bun i
  7. bun dev

Development

Run the dev server:

bun dev

Deployment

Host with Docker (recommended)

First you will need to build and push the image to a docker registry

  1. Setup a Docker registry if you don't have one (on DockerHub for example)
  2. Go to the root of this repository
  3. Build the docker container: docker build --tag <REGISTRY_URL>/merkl-lite:latest .
  4. Push it to your registry: docker push <REGISTRY_URL>/merkl-lite:latest

Now you will need to deploy the container, here are a few hosting solutions:

Then you only need to set the PORT environment variable and it will work! We recommend setting the port to 5173 (it is exposed in the Dockerfile) but feel free to change it.

Host it yourself

First, build your app for production:

npm run build

Then run the app in production mode:

npm start

Now you'll need to pick a host to deploy it to.

DIY

If you're familiar with deploying Node applications, the built-in Remix app server is production-ready.

Make sure to deploy the output of npm run build

  • build/server
  • build/client

Styling

This template comes with Tailwind CSS already configured for a simple default starting experience. You can use whatever css framework you prefer. See the Vite docs on css for more information.

Updating a fork

When pulling changes from merkl-lite, you have to:

# (On the forked repository)

# Fetch commits on merkl lite
git fetch merkl-lite

# Open a branch from main
git checkout main
git checkout -b sync

# Merge changes from upstream
git merge merkl-lite/main

# Open a sync PR