Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fission-codes/ipfs-user-settings

Portable & forkable user preferences
https://github.com/fission-codes/ipfs-user-settings

decentralized decentralized-applications demo ipfs reusable

Last synced: 3 days ago
JSON representation

Portable & forkable user preferences

Host: GitHub
URL: https://github.com/fission-codes/ipfs-user-settings
Owner: fission-codes
License: apache-2.0
Created: 2019-08-16T17:45:23.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-23T02:01:27.000Z (8 months ago)
Last Synced: 2024-12-15T11:44:12.404Z (9 days ago)
Topics: decentralized, decentralized-applications, demo, ipfs, reusable
Language: JavaScript
Homepage: https://fission-suite.github.io/ipfs-user-settings
Size: 2.69 MB
Stars: 6
Watchers: 4
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# IPFS-backed Portable User Settings

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/fission-suite/blob/master/LICENSE)
[![Maintainability](https://api.codeclimate.com/v1/badges/e42dbbb3d86970d159d9/maintainability)](https://codeclimate.com/github/fission-suite/ipfs-user-settings/maintainability)
[![Built by FISSION](https://img.shields.io/badge/⌘-Built_by_FISSION-purple.svg)](https://fission.codes)
[![Discord](https://img.shields.io/discord/478735028319158273.svg)](https://discord.gg/zAQBDEq)

A front end application to demonstrate portable user settings through IPFS. Change your preferences once and take them with you wherever you go.

### Check out the [live demo](https://fission-suite.github.io/ipfs-user-settings/) and our [forum post](https://talk.fission.codes/t/ipfs-user-settings-app/235) for a more in-depth walkthrough.

![Screenshot](./screenshot.png)

## Get started
- Install dependencies: `npm i`
- Dev mode: `npm run start`
- Prod build: `npm run build`
- Deploy to Github pages: `npm run deploy`
- Before deploying, change `homepage` in `package.json` to the url you will deploy to (ie: `$YOUR_USERNAME.github.io/ipfs-user-settings`).

## Environment
```
REACT_APP_DEFAULT_CID = QmUWWqCNSdZmus7mc52um5cpqUi1CaE97AzBTY7iWfBXV9
REACT_APP_BOOTSTRAP_NODE_TCP = /ip4/3.215.160.238/tcp/4001/ipfs/QmVLEz2SxoNiFnuyLpbXsH6SvjPTrHNMU88vCQZyhgBzgw
REACT_APP_BOOTSTRAP_NODE_WSS = /dns4/ipfs.runfission.com/tcp/4003/wss/ipfs/QmVLEz2SxoNiFnuyLpbXsH6SvjPTrHNMU88vCQZyhgBzgw
REACT_APP_INTERPLANETARY_FISSION_URL = https://runfission.com
REACT_APP_INTERPLANETARY_FISSION_USERNAME = ADD_USERNAME_HERE
REACT_APP_INTERPLANETARY_FISSION_PASSWORD = ADD_PASSWORD_HERE
```

`REACT_APP_DEFAULT_CID`: the cid that contains the default settings that you want a new user to see. You can set it to the above value for our recommended defaults (or leave it blank and it will default to that).

`REACT_APP_BOOTSTRAP_NODE_TCP`: the multiaddr of the ipfs node that you would like the user's node to connect to through tcp (for instance with a local daemon through ipfs companion). You can set it to the above value to connect to the IPFS node that Fission hosts (or leave it blank and it will default to that).

`REACT_APP_BOOTSTRAP_NODE_WSS`: the multiaddr of the ipfs node that you would like the user's node to connect to through wss (if the user does not have an ipfs-enabled browser and falls back to an in-browser js-ipfs daemon). You can set it to the above value to connect to the IPFS node that Fission hosts (or leave it blank and it will default to that). **Note:** if you use a custom node, it must be interoperable with `js-ipfs`. This means that it either needs to connect via WebRTC or Secured Websockets (notice the `wss` in the above multiaddr).

`REACT_APP_INTERPLANETARY_FISSION_...`: the last three variables are your provisioned account information for using the Fission web-api. These are used for pinning content to the Fission IPFS node so that content will stay online even after a user goes offline. If you leave them blank, the webapp will not pin user content. At the moment, these can be obtained by joining the [Fission Heroku add-on alpha](https://elements.heroku.com/addons/interplanetary-fission).