Skip to content

Commit

Permalink
📝 Add Readme & Refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
GabrielePicco committed Sep 25, 2024
1 parent 617b9e1 commit a471c4a
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
8 changes: 7 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,25 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v3
with:
path: app

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '21'
working-directory: app

- name: Install dependencies
run: npm install
working-directory: app

- name: Build the project
run: npm run build
working-directory: app

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build
publish_dir: ./app/build
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Ephemeral Counter UI

This is a React-based UI for the Ephemeral Counter program, which is part of the documentation for integrating with the Ephemeral Rollups.

## Overview

The UI demonstrates the use of Solana's ephemeral rollups with a simple counter program. It showcases an `increment` instruction that can run both on the main network and ephemeral rollup.

## Documentation

For more information, visit: [Ephemeral Rollups Documentation](https://docs.magiblock.gg/Accelerate/ephemeral_rollups).

## Getting Started

### Prerequisites

- Node.js
- npm

### Installation

1. Navigate to the `app` directory
2. Install the dependencies:


npm install


### Running the Application

To start the application, run:


npm run start


### Set a custom RPC endpoint

To set a custom RPC endpoint, you can use the `REACT_APP_MAGICBLOCK_URL` environment variable. For example for running locally:

REACT_APP_MAGICBLOCK_URL=http://localhost:8899 npm run start

0 comments on commit a471c4a

Please sign in to comment.