Skip to content

Commit

Permalink
chore: clean README and remove SDK_ACCESS_TOKEN
Browse files Browse the repository at this point in the history
  • Loading branch information
Picodes committed Dec 4, 2024
1 parent b59b7fc commit 1a5985e
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 49 deletions.
2 changes: 0 additions & 2 deletions .github/actions/setup-repo/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,4 @@ runs:
bun-version: latest
- name: Install dependencies
run: bun install
env:
SDK_READ_ACCESS_TOKEN: ${{ secrets.SDK_READ_ACCESS_TOKEN }}
shell: bash
2 changes: 0 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,5 @@ jobs:
bun-version: latest
- name: Install dependencies
run: bun install
env:
SDK_READ_ACCESS_TOKEN: ${{ secrets.SDK_READ_ACCESS_TOKEN }}
- name: Lint merkl-api codebase
run: bun lint:ci
2 changes: 1 addition & 1 deletion .github/workflows/update_staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
run: |
export SHORT_SHA=${GITHUB_SHA:0:7}
docker pull $IMAGE_URL:latest || true
docker build --build-arg SDK_READ_ACCESS_TOKEN=${{ secrets.SDK_READ_ACCESS_TOKEN }} --cache-from $IMAGE_URL:latest --tag $IMAGE_URL:$SHORT_SHA --tag $IMAGE_URL:latest .
docker build --cache-from $IMAGE_URL:latest --tag $IMAGE_URL:$SHORT_SHA --tag $IMAGE_URL:latest .
- name: Push image
run: |
export SHORT_SHA=${GITHUB_SHA:0:7}
Expand Down
1 change: 0 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
FROM oven/bun:1.1.24-debian
ARG SDK_READ_ACCESS_TOKEN

RUN apt-get -y update
RUN apt-get -y install python3 make g++ ca-certificates curl
Expand Down
77 changes: 42 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,47 @@
# Welcome to Remix!

- 📖 [Remix docs](https://remix.run/docs)
## 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]]([email protected])

### Full License

For detailed terms and conditions, refer to the [`LICENSE`](./LICENSE) file in this repository.


# Welcome to Merkl Lite !

## Prerequisites
- [Bun](https://bun.sh/)
- [Remix](https://remix.run/docs)

## Installation

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

## Development

Run the dev server:

```shellscript
npm run dev
```

## Updating a fork

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

bun dev
```
# (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
```

## Deployment

Expand Down Expand Up @@ -67,20 +72,22 @@ Make sure to deploy the output of `npm run build`

This 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.

## License
## Updating a fork

This project is licensed under the **BSD 3-Clause License with Specific Usage Restrictions**.
When pulling changes from `merkl-lite`, you have to:

### Key Terms
```
# (On the forked repository)
- **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]]([email protected])
# Fetch commits on merkl lite
git fetch merkl-lite
### Full License
# Open a branch from main
git checkout main
git checkout -b sync
For detailed terms and conditions, refer to the [`LICENSE`](./LICENSE) file in this repository.
# Merge changes from upstream
git merge merkl-lite/main
# Open a sync PR
```
Binary file modified bun.lockb
Binary file not shown.
5 changes: 0 additions & 5 deletions bunfig.toml

This file was deleted.

2 changes: 0 additions & 2 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ services:
image: merkl-lite
build:
context: .
args:
SDK_READ_ACCESS_TOKEN: $GITHUB_REGISTRY_TOKEN
dockerfile: Dockerfile
ports:
- '5173:5173'
Expand Down
2 changes: 1 addition & 1 deletion packages/dappkit
Submodule dappkit updated 53 files
+0 −50 LICENSE.md
+32 −78 README.md
+2 −2 package.json
+1 −3 src/components.ts
+2 −2 src/components/VisuallyHidden.tsx
+5 −4 src/components/dapp/Countdown.tsx
+9 −4 src/components/dapp/TransactionButton.tsx
+8 −8 src/components/dapp/TransactionHelper.tsx
+39 −68 src/components/dapp/WalletButton.tsx
+9 −24 src/components/dapp/WalletConnectors.tsx
+13 −8 src/components/extenders/Card.tsx
+24 −15 src/components/extenders/Dropdown.tsx
+3 −1 src/components/extenders/Group.tsx
+5 −17 src/components/extenders/Icons.tsx
+5 −7 src/components/extenders/Modal.tsx
+42 −56 src/components/extenders/Select.tsx
+11 −3 src/components/layout/Container.tsx
+29 −8 src/components/primitives/Accordion.tsx
+1 −1 src/components/primitives/Bar.tsx
+2 −2 src/components/primitives/Box.tsx
+37 −62 src/components/primitives/Button.tsx
+17 −4 src/components/primitives/Checkbox.tsx
+11 −4 src/components/primitives/Collapsible.tsx
+25 −45 src/components/primitives/Divider.tsx
+24 −13 src/components/primitives/Hash.tsx
+12 −3 src/components/primitives/Icon.tsx
+49 −43 src/components/primitives/Input.tsx
+1 −1 src/components/primitives/List.tsx
+0 −67 src/components/primitives/PrimitiveTag.tsx
+5 −2 src/components/primitives/Scroll.tsx
+25 −7 src/components/primitives/Slider.tsx
+6 −7 src/components/primitives/Table.tsx
+25 −10 src/components/primitives/Text.tsx
+64 −23 src/components/primitives/Title.tsx
+9 −4 src/components/primitives/Tooltip.tsx
+23 −15 src/components/primitives/Value.tsx
+100 −25 src/config/themes.ts
+1 −0 src/constants/SCREENS.json
+10 −20 src/context/Dapp.context.tsx
+37 −21 src/context/Theme.context.tsx
+4 −6 src/context/Wallet.context.tsx
+7 −2 src/hooks/theming/OverrideTheme.tsx
+3 −3 src/hooks/theming/useThemableProps.tsx
+13 −4 src/hooks/theming/useThemedVariables.tsx
+21 −23 src/hooks/useClipboard.tsx
+7 −3 src/hooks/useWalletState.tsx
+4 −4 src/index.ts
+1 −1 src/style.css
+49 −0 src/theme/variabless.ts
+4 −4 src/theming/coloring.ts
+7 −9 src/utils/event.ts
+9 −9 src/utils/react.ts
+19 −12 src/utils/tailwind.ts

0 comments on commit 1a5985e

Please sign in to comment.