{"id":22873961,"url":"https://github.com/angleprotocol/merkl-lite","last_synced_at":"2025-05-07T18:21:03.511Z","repository":{"id":266485393,"uuid":"859425789","full_name":"AngleProtocol/merkl-lite","owner":"AngleProtocol","description":"Template App to showcase Merkl Opportunities","archived":false,"fork":false,"pushed_at":"2025-01-14T16:02:53.000Z","size":7009,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T12:57:17.950Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://merkl.xyz/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AngleProtocol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-18T16:32:08.000Z","updated_at":"2025-01-14T16:02:56.000Z","dependencies_parsed_at":"2024-12-04T14:31:46.351Z","dependency_job_id":"29eb5375-fa6c-44d9-b922-657f6f60c5da","html_url":"https://github.com/AngleProtocol/merkl-lite","commit_stats":null,"previous_names":["angleprotocol/merkl-lite"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AngleProtocol%2Fmerkl-lite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AngleProtocol%2Fmerkl-lite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AngleProtocol%2Fmerkl-lite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AngleProtocol%2Fmerkl-lite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AngleProtocol","download_url":"https://codeload.github.com/AngleProtocol/merkl-lite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252931814,"owners_count":21827171,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-13T14:32:04.507Z","updated_at":"2025-05-07T18:21:03.484Z","avatar_url":"https://github.com/AngleProtocol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n## License\n\nThis project is licensed under the **BSD 3-Clause License with Specific Usage Restrictions**.\n\n### Key Terms\n\n- **Permitted Use**: This software may only be used to develop applications (frontend or backend) that directly interface with the Merkl incentive distribution solution.\n- **Prohibited Uses**:\n  - Developing standalone applications unrelated to the original backend.\n  - Creating competitive backend services or applications.\n  - Reverse engineering the core backend logic.\n  - Developing alternative backend implementations.\n- **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 [contact@merkl.xyz](contact@merkl.xyz)\n\n### Full License\n\nFor detailed terms and conditions, refer to the [`LICENSE`](./LICENSE) file in this repository.\n\n\n# Welcome to Merkl Lite !\n\n## Prerequisites\n\n- [Bun](https://bun.sh/)\n- [Remix](https://remix.run/docs)\n\n## Installation\n\n1. Go to `cd packages/dappkit`\n2. `git submodule init`\n3. `git submodule update`\n4. `bun i`\n5. `cd ../..`\n6. `bun i`\n7. `bun dev`\n\n## Development\n\nRun the dev server:\n\n```shellscript\nbun dev\n```\n\n\n## Deployment\n\n### Host with Docker (recommended)\n\nFirst you will need to build and push the image to a docker registry\n\n1. Setup a Docker registry if you don't have one (on [DockerHub](https://hub.docker.com/) for example)\n2. Go to the root of this repository\n3. Build the docker container: `docker build --tag \u003cREGISTRY_URL\u003e/merkl-lite:latest .`\n4. Push it to your registry: `docker push \u003cREGISTRY_URL\u003e/merkl-lite:latest`\n\nNow you will need to deploy the container, here are a few hosting solutions:\n\n- [Cloud Run](https://cloud.google.com/run) on Google Cloud\n- [ECS Fargate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) on AWS\n- Docker-compose on any VM\n\nThen 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.\n\n### Host it yourself\n\nFirst, build your app for production:\n\n```sh\nnpm run build\n```\n\nThen run the app in production mode:\n\n```sh\nnpm start\n```\n\nNow you'll need to pick a host to deploy it to.\n\n### DIY\n\nIf you're familiar with deploying Node applications, the built-in Remix app server is production-ready.\n\nMake sure to deploy the output of `npm run build`\n\n- `build/server`\n- `build/client`\n\n## Styling\n\nThis template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever css framework you prefer. See the [Vite docs on css](https://vitejs.dev/guide/features.html#css) for more information.\n\n## Updating a fork\n\nWhen pulling changes from `merkl-lite`, you have to:\n\n```\n# (On the forked repository)\n\n# Fetch commits on merkl lite\ngit fetch merkl-lite\n\n# Open a branch from main\ngit checkout main\ngit checkout -b sync\n\n# Merge changes from upstream\ngit merge merkl-lite/main\n\n# Open a sync PR\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangleprotocol%2Fmerkl-lite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fangleprotocol%2Fmerkl-lite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangleprotocol%2Fmerkl-lite/lists"}