An open API service indexing awesome lists of open source software.

https://github.com/gadingnst/demo-dapps

Demo how to develop DApps with TwoPointFive Web3 SDK
https://github.com/gadingnst/demo-dapps

Last synced: 6 months ago
JSON representation

Demo how to develop DApps with TwoPointFive Web3 SDK

Awesome Lists containing this project

README

          

# Learn DApps

# Table of Contents
- [Learn DApps](#learn-dapps)
- [Table of Contents](#table-of-contents)
- [Prerequisite](#prerequisite)
- [How to setup](#how-to-setup)
- [What's inside?](#whats-inside)
- [Apps and Packages](#apps-and-packages)
- [Apps](#apps)
- [Packages](#packages)
- [Utilities](#utilities)
- [Build](#build)
- [Develop](#develop)
- [Remote Caching](#remote-caching)
- [Useful Links](#useful-links)

## Prerequisite
1. [NodeJS 18](https://nodejs.org/en/)

## How to setup
1. Run `npm install`

## What's inside?
This turborepo uses [npm](https://www.npmjs.com/) as a package manager. It includes the following packages/apps:

### Apps and Packages
#### Apps
- `election`: another [Next.js](https://nextjs.org/) app for experimenting `web3-sdk` package.
- `smart-contracts`: a [Hardhat](https://hardhat.org) project for contract development in `example-election` project.

#### Packages
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `tsconfig`: `tsconfig.json`s used throughout the monorepo

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).

### Utilities

This turborepo has some additional tools already setup for you:

- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting

### Build

To build all apps and packages, run the following command:

```
cd learn-dapps
npm run build
```

### Develop

To develop all apps and packages, run the following command:

```
cd learn-dapps
npm run dev
```

### Remote Caching

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.

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:

```
cd my-turborepo
npx turbo login
```

This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

```
npx turbo link
```

## Useful Links

Learn more about the power of Turborepo:

- [Pipelines](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)