-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(cherry picked from commit 60d8619344f7e6e4966f9bd718f6719ea8c0ea98)
- Loading branch information
Showing
2 changed files
with
61 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,60 @@ | ||
# hyperchains-ui | ||
# Hyperchains UI | ||
|
||
This repo contains an user interface that simplifies the process of setting up a custom Hyperchain. | ||
|
||
## Access | ||
|
||
Find a hosted version of the interface over at [hyperchains.ae](https://hyperchains.ae) or | ||
feel free to run it on your own machine using the instructions in the following section. | ||
|
||
## Local development | ||
|
||
### Prerequisites | ||
|
||
- **[Node.js](https://nodejs.org/en/download)**: Version 22.13.0 or higher | ||
- **Docker** (optional) | ||
|
||
### Installation | ||
|
||
1. **Clone the Repository**: | ||
|
||
```bash | ||
git clone https://github.com/aeternity/hyperchains-ui.git | ||
cd hyperchains-ui | ||
``` | ||
|
||
2. **Install Dependencies**: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
3. **Run Development Server**: | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
The interface is now accessible at http://localhost:3000/ | ||
|
||
4. **Build for Production**: | ||
```bash | ||
npm run build | ||
``` | ||
|
||
### 🐳 Docker Setup | ||
|
||
To use Docker, make sure Docker is installed on your machine. Then, build and run the Docker container: | ||
|
||
```bash | ||
docker build -t hyperchains-ui . | ||
docker run --name hyperchains-ui -p 3000:3000 hyperchains-ui | ||
``` | ||
|
||
## Feedback | ||
|
||
For bug reports or feature requests, please use the issues: [https://github.com/aeternity/hyperchains-ui/issues/new/choose](https://github.com/aeternity/hyperchains-uii/issues/new/choose) | ||
|
||
## License | ||
|
||
This repository is licensed using the [ISC license](https://github.com/aeternity/hyperchains-ui/blob/main/LICENSE.md) |