Awesome Open Source
Awesome Open Source

SubSocial Web UI by DappForce

SubSocial is a set of Substrate runtime modules (SRML) with UI that would allow anyone to launch their own decentralized censorship-resistant social network aka community. We are planning to follow a topology of Polkadot Network where every community will be running on its own Substrate chain and all these decentralized communities will be connected to our own Polkadot relay. This social networking relay could be connected to the official Polkadot Network.

You can think of this as decentralized versions of Reddit, Stack Exchange or Medium, where subreddits or communities of Stack Exchange or blogs on Medium run on their own chain. At the same time, users of these decentralized communities should be able to transfer or share their reputation, coins and other values from one community to another via Polkadot relay.

Overview

The repo is split into a number of packages, each representing an application. These are -

  • apps This is the main entry point. It handles the selection sidebar and routing to the specific application being displayed.
  • page-accounts A basic account management app.
  • page-address-book A basic address management app.
  • page-democracy A basic voting app, allowing votes on activate proposals and referenda.
  • page-explorer A simple block explorer. It only shows the most recent blocks, updating as they become available.
  • page-extrinsics Submission of extrinsics to a node.
  • page-js An online code editor with @polkadot-js/api access to the currently connected node.
  • page-settings A basic settings management app, allowing choice of language, node to connect to, and theme
  • page-staking A basic staking management app, allowing staking and nominations.
  • page-storage A simple node storage query application. Multiple queries can be queued and updates as new values become available.
  • page-toolbox Submission of raw data to RPC endpoints and utility hashing functions.
  • page-transfer A basic account management app, allowing transfer of Units/DOTs between accounts.

In addition the following libraries are also included in the repo. These are to be moved to the @polkadot/ui repository once it reaches a base level of stability and usability. (At this point with the framework being tested on the apps above, it makes development easier having it close)

  • react-components A reactive (using RxJS) application framework with a number of useful shared components.
  • react-signer Signer implementation for apps.
  • react-query Base components that use the RxJS Observable APIs

development

Contributions are welcome!

To start off, this repo (along with others in the @polkadot family) uses yarn workspaces to organize the code. As such, after cloning dependencies should be installed via yarn, not via npm, the latter will result in broken dependencies.

To get started -

  1. Clone the repo locally, via git clone https://github.com/polkadot-js/apps <optional local path>
  2. Ensure that you have a recent LTS version of Node.js, for development purposes Node >=10.13.0 is recommended.
  3. Ensure that you have a recent version of Yarn, for development purposes Yarn >=1.10.1 is required.
  4. Install the dependencies by running yarn
  5. Ready! Now you can launch the UI (assuming you have a local Polkadot Node running), via yarn run start
  6. Access the UI via http://localhost:3000

I want to code around

There is a base template available page-123code that acts as a simple starting point for adding additional apps to the UI. Alternatively if you just want some place where you can write some code, it does the trick.

While it is hidden from the sidebar, it is accessible via http://127.0.0.1:3000/#/123code

Be sure to follow the page-123code/README.md instructions.

Docker

You can run a docker container via -

docker run --rm -it --name polkadot-ui -p 80:80 chevdor/polkadot-ui:latest

To build a docker container containing local changes -

docker build -t chevdor/polkadot-ui:latest .

When using these Docker commands, you can access the UI via http://localhost:80 (or just http://localhost)


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Blockchain (8,513
Social Network (1,577
Dapp (1,398
Decentralized (862
Blog Engine (466
Substrate (294
Polkadot (226
Related Projects