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

https://github.com/fairdatasociety/fdp-todo-app-tutorial

An interactive how-to guide for beginners on getting started with building dApps on Fair Data Protocol using fdp-storage, FairOS and fdp-play.
https://github.com/fairdatasociety/fdp-todo-app-tutorial

fairdataprotocol fairos fdp-storage todoapp tutorial

Last synced: 12 months ago
JSON representation

An interactive how-to guide for beginners on getting started with building dApps on Fair Data Protocol using fdp-storage, FairOS and fdp-play.

Awesome Lists containing this project

README

          

# Getting Started with Fair Data Protocol (FDP)

An interactive how-to guide for beginners on getting started with building dApps on Fair Data Protocol using `fdp-storage`, `FairOS` and `fdp-play`.

Independent Todo apps built using the two approaches described in this tutorial:
- `fdp-storage` & `fdp-play` : https://github.com/fairDataSociety/fdp-storage-TODO-app-example
- `FairOS` & `fdp-play` : https://github.com/fairDataSociety/fairos-TODO-app-example

---
#### Diagram 1: Fair Data Protocol - Creating Accounts
![image](https://raw.githubusercontent.com/fairDataSociety/fdp-TODO-app-tutorial/main/public/fdp.svg)

---
#### Diagram 2: Creating Accounts wit FdpStorage / Blossom
![image](https://raw.githubusercontent.com/fairDataSociety/fdp-TODO-app-tutorial/main/public/fdpstorage.svg)

---
#### Diagram 3: Blossom browser extension
![image](https://raw.githubusercontent.com/fairDataSociety/fdp-TODO-app-tutorial/main/public/blossom.svg)

---
## Local Development Setup

### Prerequisites:

**Requirements:**

- Docker must be already installed
- `node >= 16`

#### Install `fdp-play` globally
```shell
$ npm install -g @fairdatasociety/fdp-play
```

#### Spin up a local FDP development environment with fairos
```shell
$ fdp-play start --fairos
```

### Setup & Installation:

#### Clone the repo
```shell
$ git clone https://github.com/fairDataSociety/fdp-TODO-app-tutorial.git
```

```shell
$ cd fdp-TODO-app-tutorial
```

### Install dependencies
```shell
$ npm install
```

### Run application
**Requirements:** `fdp-play` must be running already!

```shell
$ npm run dev
```

The application can be viewed at - http://localhost:5173/

### Screenshots

![image](https://user-images.githubusercontent.com/520570/210038808-d84ed496-ec43-4be2-bca3-362c7d49c15f.png)

---

![image](https://user-images.githubusercontent.com/520570/210038865-cb215262-98be-40f4-ac0e-8726dafb1423.png)

---

![image](https://user-images.githubusercontent.com/520570/207890048-6502ab71-3e30-4e85-bbe7-b89444a17a0f.png)