https://github.com/antho31/okp4-ui-boilerplate

🖥️ Vite starter for the OKP4 protocol
https://github.com/antho31/okp4-ui-boilerplate

Last synced: 4 days ago
JSON representation

🖥️ Vite starter for the OKP4 protocol

• Host: GitHub
• URL: https://github.com/antho31/okp4-ui-boilerplate
• Owner: antho31
• License: bsd-3-clause
• Created: 2023-08-28T08:35:19.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-04T09:21:52.000Z (about 1 year ago)
• Last Synced: 2024-08-01T13:36:57.613Z (3 months ago)
• Language: TypeScript
• Homepage: https://okp4-vite-starter.on.fleek.co/
• Size: 2.64 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - antho31/okp4-ui-boilerplate - 🖥️ Vite starter for the OKP4 protocol (TypeScript)

README

        
# OKP4 Boilerplate with React + TypeScript + Vite

> Boilerplate to craft UIs that interact with the [@okp4](https://okp4.network) protocol. Refer to the [tutorial for guidance on creating such interfaces](./TUTORIAL.md).

[![lint](https://img.shields.io/github/actions/workflow/status/okp4/template-oss/lint.yml?branch=main&label=lint&style=for-the-badge&logo=github)](https://github.com/okp4/template-oss/actions/workflows/lint.yml)

[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge&logo=conventionalcommits)](https://conventionalcommits.org)

[![contributor covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](https://github.com/okp4/.github/blob/main/CODE_OF_CONDUCT.md)

[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge)](https://opensource.org/licenses/BSD-3-Clause)

Front-end boilerplate to rapidly develop UIs for interacting with the OKP4 blockchain. Utilizing Vite, it shows how to handle the connection, the interaction with smart contracts, and the decoding of transactions.

![Preview](./src/assets/webapp-7.webp)

---

## 🌟 Features

- Pre-configured setup to connect to OKP4 testnet

- Utility functions and [Graz](https://graz.sh/docs/) hooks to call, deploy, and interact with [OKP4 smart contracts](https://github.com/okp4/contracts)

- Decode transactions to analyze onchain Prolog programs and more

## 🛠 Prerequisites

- Node.js = 18.x

## 🖥 Get started

### Development

To set up and run the project locally, follow the following steps:

```bash

npm i

npm run dev

```

### Deployment

Build and serve the `dist` folder:

```bash

npm i

npm run build

```

To deploy your Vite.js site on decentralized, open technologies that prioritize user control, consider transitioning to Web3 by [hosting on Fleek.co](https://mirror.xyz/joshcstein.eth/UbInedh4ToAAfsDklzSPb3R1_hVSHIdE97hvxIWYlOo) (using the `node:18` Docker Image Name). This not only allows you to set a custom domain name but also benefits from IPFS's censorship-resistant P2P hosting and ENS domain linking.

## 🆘 Support

For bugs 🐛, feature requests 🌈, or other queries ❓, open an issue in the GitHub repository.

## You want to get involved? 😍

Please check out OKP4 health files :

- [Contributing](https://github.com/okp4/.github/blob/main/CONTRIBUTING.md)

- [Code of conduct](https://github.com/okp4/.github/blob/main/CODE_OF_CONDUCT.md)