Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oranj-base/strike
Sharable actions on ICP
https://github.com/oranj-base/strike
actions internetcomputer sharable strike
Last synced: 16 days ago
JSON representation
Sharable actions on ICP
- Host: GitHub
- URL: https://github.com/oranj-base/strike
- Owner: oranj-base
- License: apache-2.0
- Created: 2024-08-12T09:53:54.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-03T09:39:26.000Z (about 1 month ago)
- Last Synced: 2024-12-03T10:35:06.588Z (about 1 month ago)
- Topics: actions, internetcomputer, sharable, strike
- Language: TypeScript
- Homepage: https://strike.oranj.co
- Size: 7.49 MB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# STRIKE - Share Actionable Links with Ease
[](https://internetcomputer.org)
[](https://github.com/oranj-base/strike/blob/main/packages/core)
[](https://github.com/oranj-base/strike/blob/main/canisters/strike_backend)
[](https://github.com/oranj-base/strike/tree/main/apps/chrome-extension)
---
## Overview
STRIKE enables users to share **actionable links** that unfurl into **interactive Strike Cards** on social media platforms, allowing seamless engagement with custom actions. Strike makes it easy to integrate blockchain actions with popular platforms like Twitter (X), offering users a one-click interaction with predefined actions.
STRIKE consists of three main components:
- **STRIKE [Core Library](./packages/core)**: The core logic and API interface for creating and managing Strike Cards.
- **STRIKE [Registry Canister](./canisters/strike_backend)**: A backend service that handles action requests and manages metadata.
- **STRIKE [Chrome Extension](./apps/chrome-extension)**: Enables users to interact with Strike Cards and execute actions directly from their browser.
---
## How STRIKE Works
STRIKE simplifies the process of sharing actionable links on social media platforms. Users can create custom actions defined in a **JSON file** and host it publicly. When a user shares a link, it unfurls into an **interactive Strike Card** on platforms like Twitter (X), allowing other users to engage with the actions in just one click.
### Key Steps:
1. **Install the Chrome Extension**
Users need to install the Strike Chrome extension, which enables the rendering of Strike Cards and executing actions directly from the browser.
2. **Create and Host the Actions File**
Define the actions you want users to perform in a **JSON file** (like `actions.json`). Host it on a public server, and use it to generate interactive Strike Cards.
3. **Share and Engage with Strike Cards**
Once the hosted link is shared on social media, it unfurls into a **Strike Card**, allowing users to perform actions such as placing bets or managing assets.
### Schema Definition
The schema for defining actions and creating Strike Cards will be provided soon. For now, refer to the [example actions.json](./apps/site/public/actions.json), which outlines how actions are structured.
---
## Components Breakdown
- **[Core Library](./packages/core)**: The core library contains the essential logic for creating and managing Strike Cards. It processes the JSON schema and handles the backend integration with the registry canister.
- **[Registry Canister](./canisters/strike_backend)**: The backend canister that manages metadata and action requests. It acts as the server-side component where actions are stored and validated before execution.
- **[Chrome Extension](./apps/chrome-extension)**: The Chrome extension is required for rendering Strike Cards on platforms like Twitter (X) and enables users to interact with those actions directly in their browser. Without the extension, only the metadata will be visible, but actions won't be executable.
---
Stay tuned for more updates and detailed documentation on how to fully integrate and leverage the power of STRIKE.
> [!NOTE]
> This project is under active development, and there may be breaking changes before the official release.