-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from hollow-leaf/redesign/main-page
feat: main-page & readme
- Loading branch information
Showing
9 changed files
with
161 additions
and
183 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,83 +1,99 @@ | ||
# Turborepo starter | ||
<div align="center"> | ||
<h1>Konan</h1> | ||
|
||
This is an official starter Turborepo. | ||
<img src="https://cloudflare-ipfs.com/ipfs/QmZzuPWuvRWyGxAkGcTcGhnNDdJ3evrKZDuWbb73PhWLH9/" width="50%" height="50%"></img> | ||
|
||
## Using this example | ||
[![Frontend deploy](https://github.com/hollow-leaf/Konan/actions/workflows/ghpage.yml/badge.svg?branch=main)](https://github.com/hollow-leaf/Konan/actions/workflows/ghpage.yml) | ||
|
||
Run the following command: | ||
</div> | ||
|
||
```sh | ||
npx create-turbo@latest | ||
``` | ||
### Demo Page | ||
|
||
## What's inside? | ||
- Video: [Konan demo](https://youtu.be/aFThCDy1UNg?si=9SaA8jX0pGBX45nK) | ||
- Konan Contract: | ||
- Arbitrum Sepolia: [BlackStone](https://sepolia.arbiscan.io/address/0x585a1DDaB9116F483d367bCa6eb64797252051c8) | ||
- ChainLink VRF: | ||
- Celestia: | ||
|
||
This Turborepo includes the following packages/apps: | ||
### Abstract | ||
|
||
### Apps and Packages | ||
Konan is at the forefront of the digital revolution, providing developers with a groundbreaking platform to craft their unique Dynamic Non-Fungible Tokens (DNFTs). Our mission is to democratize the creation and validation of NFT metadata, empowering developers to unleash their creativity and revolutionize the digital asset landscape. | ||
|
||
- `docs`: a [Next.js](https://nextjs.org/) app | ||
- `web`: another [Next.js](https://nextjs.org/) app | ||
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications | ||
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) | ||
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo | ||
### Introduction | ||
|
||
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). | ||
With Konan, developers can tap into a world of endless possibilities by creating DNFTs tailored to their specific needs and visions. Whether it's artwork, collectibles, virtual real estate, or any other digital asset, Konan provides the tools and infrastructure to bring your ideas to life in the form of DNFTs. | ||
|
||
### Utilities | ||
Celestia seamlessly integrates with our DNFT platform, allowing developers to effortlessly validate the metadata of their NFTs. By leveraging Celestia's advanced verification mechanisms, developers can ensure the authenticity and integrity of their DNFTs, providing peace of mind to both creators and collectors alike. | ||
|
||
This Turborepo has some additional tools already setup for you: | ||
Konan's integration with ChainLink streamlines the DNFT generation process, allowing developers to effortlessly incorporate external data into their digital assets.Konan ensures that DNFTs reflect the latest and most relevant information, enhancing their value and utility. | ||
|
||
- [TypeScript](https://www.typescriptlang.org/) for static type checking | ||
- [ESLint](https://eslint.org/) for code linting | ||
- [Prettier](https://prettier.io) for code formatting | ||
<br/> | ||
|
||
### Build | ||
### Key Features | ||
|
||
To build all apps and packages, run the following command: | ||
- Streamlined DNFT Creation: Konan's intuitive interface and seamless ChainLink integration make DNFT creation effortless, allowing developers to focus on unleashing their creativity without worrying about technical complexities. | ||
|
||
``` | ||
cd my-turborepo | ||
pnpm build | ||
``` | ||
- Enhanced Authenticity: By incorporating real-time data feeds, Celestia ensures the authenticity and uniqueness of DNFTs, providing both creators and collectors with confidence in the integrity of their digital assets. | ||
|
||
### Develop | ||
- User-Friendly Interface: Celestia's intuitive platform ensures that DNFT creation is accessible to all users, regardless of technical expertise. | ||
|
||
To develop all apps and packages, run the following command: | ||
|
||
``` | ||
cd my-turborepo | ||
pnpm dev | ||
``` | ||
### Our solution: | ||
|
||
### Remote Caching | ||
- Chainlink VRF (Verifiable Random Function):Generate Dynamic NFT | ||
- Celestia Data Avalibility:Verify ERC-721A token metadata avalibility using Celestia | ||
- Data Security:Ensures transparency and security with Celestia blockchain technology | ||
- UI/UX friendly:Easy integration with a simple interface for users to mint NFT | ||
|
||
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. | ||
### Methods | ||
|
||
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands: | ||
- Use [Celestia](https://celestia.org/what-is-celestia/) to access nft metadata and verify MetaData URI | ||
- Use [ChainkLink](https://chain.link/) VRF to draw nft accessory | ||
- Use [Arbitrum](https://arbitrum.io/) to deploy Smart Contract | ||
- Use [Solidity](https://soliditylang.org/) to develop smart contract | ||
- Use [IPFS](https://ipfs.tech/) to access nft photo and metadata | ||
- Use [Next.js](https://nextjs.org/) to build frontend web | ||
- Use [Cloudflare_serverless](https://developers.cloudflare.com/pages/framework-guides/deploy-a-hono-site/) to build serverless | ||
- Use [Golang](https://go.dev/) to develop backend server | ||
|
||
``` | ||
cd my-turborepo | ||
npx turbo login | ||
### Technical Architecture | ||
Konan Architecture | ||
![Konan Architecture](https://github.com/hollow-leaf/psyduck/blob/main/apps/extension_app/img/Psyduck_architeture.png?raw=true) | ||
|
||
Konan workflow | ||
```mermaid | ||
sequenceDiagram | ||
actor User | ||
participant Konan | ||
participant Aribtrum smart contract | ||
participant ChainLink VRF | ||
participant Celestia | ||
``` | ||
|
||
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). | ||
### Building & Installation | ||
|
||
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: | ||
> Konan is a monorepo managed using turbo. You can find the source code for each package in the apps/web and package/contract directory. | ||
- apps/web is the Frontend web for Konan. It is built using [Next.js](https://nextjs.org/). | ||
- package/contract is the smart contract for Konan. It is built using [Solidity](https://soliditylang.org/). | ||
|
||
## Setting project | ||
### Run Project | ||
``` | ||
npx turbo link | ||
git clone https://github.com/hollow-leaf/Konan/tree/main | ||
``` | ||
``` | ||
pnpm i | ||
``` | ||
``` | ||
pnpm dev | ||
``` | ||
|
||
## Useful Links | ||
|
||
Learn more about the power of Turborepo: | ||
|
||
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) | ||
- [Caching](https://turbo.build/repo/docs/core-concepts/caching) | ||
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) | ||
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) | ||
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration) | ||
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) | ||
### Contributors | ||
|
||
# fullstack_template | ||
- System Architect: [Solo Lin](https://github.com/LinXJ1204) | ||
- Frontend engineer: [Jake Kuo](https://github.com/crypto0627) | ||
- Smart Contract developer: [Albert Cheng](https://github.com/cheng-chun-yuan) | ||
- Designer: [Sophia Liang](https://github.com/Showyuan) |
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
Oops, something went wrong.