Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/P2PModels/wiki
An Unstoppable Wiki for the Right to Access Knowledge
https://github.com/P2PModels/wiki
aragon-applications dao ipfs
Last synced: 2 months ago
JSON representation
An Unstoppable Wiki for the Right to Access Knowledge
- Host: GitHub
- URL: https://github.com/P2PModels/wiki
- Owner: P2PModels
- License: agpl-3.0
- Created: 2019-01-07T00:01:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:42:32.000Z (about 2 years ago)
- Last Synced: 2024-08-04T05:01:29.602Z (6 months ago)
- Topics: aragon-applications, dao, ipfs
- Language: JavaScript
- Homepage: https://p2pmodels.eu
- Size: 2.5 MB
- Stars: 30
- Watchers: 6
- Forks: 4
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-aragon - Wiki
README
# P2P Models Wiki dApp
An Unstoppable Wiki for the Right to Access Knowledge.
> There is more than one way to burn a book. And the world is full of people running about with lit matches. – Ray Bradbury, Fahrenheit 451
> The Internet treats censorship as a malfunction and routes around it. – John Perry Barlow
This Wiki dApp uses [Aragon](https://aragon.org) and [IPFS](https://ipfs.io) in order to enable a distributed editable and permissioned wiki. Wikis like that are imperative in a world where [Wikipedia is censored](https://blog.ipfs.io/24-uncensorable-wikipedia/) in some states.
**Important:** You need to be running an IPFS node on your computer in order to see and edit wiki pages. [Install IPFS](https://dist.ipfs.io/#go-ipfs) and initialize its daemon with `ipfs daemon`. It is needed even when visiting DAOs from aragonpm.org.
## This is how it looks like
### Edition
Pages can be edited using markdown:
### Many Pages
In the sidebar there are the wiki pages, and more can be created:
### Page protection
A page can be protected, so only people or apps with the right permissions can edit it:
## Usage
You can start the wiki on a local Ethereum devchain as follows:
```sh
git clone https://github.com/p2pmodels/wiki
cd wiki
npm install
npm start
```
## Installing the Wiki dApp on a Rinkeby DAO
This Wiki Aragon app is published in the AragonPM package manager on Rinkeby, so it can be
installed to any Aragon DAO on that network. In order to deploy this app on an existing DAO,
you can do the following:
```sh
$ npm install -g @aragon/cli --unsafe-perms=true
$ dao install .aragonid.eth wiki.open.aragonpm.eth --environment aragon:rinkeby
# -> Depending on your DAO permissions, a voting may have been issued. The voting must pass in order to continue.
$ dao apps --all .aragonid.eth --environment aragon:rinkeby
# -> You should see a list of apps, and the listed under permissionless apps.
$ dao acl create .aragonid.eth EDIT_ROLE --environment aragon:rinkeby
$ dao acl create .aragonid.eth CREATE_ROLE --environment aragon:rinkeby
$ dao acl create .aragonid.eth PROTECT_ROLE --environment aragon:rinkeby
# -> You may vote all this permission changes
```
### Using HTTP for development
Running your app using HTTP will allow for a faster development process of your app's front-end, as it can be hot-reloaded without the need to execute `aragon run` every time a change is made.
- First start your app's development server running `npm run start:app`, and keep that process running. By default it will rebuild the app and reload the server when changes to the source are made.
- After that, you can run `npm run start:http` or `npm run start:http:template` which will compile your app's contracts, publish the app locally and create a DAO. You will need to stop it and run it again after making changes to your smart contracts.
Changes to the app's background script (`app/src/script.js`) cannot be hot-reloaded, after making changes to the script, you will need to either restart the development server (`npm run start:app`) or rebuild the script with `cd app; npm run build:script`.
### npm Scripts
- **start** or **start:ipfs**: Runs your app inside a DAO served from IPFS
- **start:http**: Runs your app inside a DAO served with HTTP (hot reloading)
- **start:ipfs:template**: Creates a DAO with the [Template](https://github.com/p2pmodels/wiki/blob/master/contracts/Template.sol) and serves the app from IPFS
- **start:http:template**: Creates a DAO with the [Template](https://github.com/p2pmodels/wiki/blob/master/contracts/Template.sol) and serves the app with HTTP (hot reloading)
- **prepare**: Installs dependencies of the front-end
- **start:app**: Starts a development server for your app
- **compile**: Compiles the smart contracts
- **build**: Builds the front-end and background script
- **test**: Runs tests for the contracts
- **publish:patch**: Releases a patch version to aragonPM (only frontend/content changes allowed)
- **publish:minor**: Releases a minor version to aragonPM (only frontend/content changes allowed)
- **publish:major**: Releases a major version to aragonPM (frontend **and** contract changes)
- **versions**: Checks the currently installed versions of the app
- **lint**: Checks the app and the contracts for linting errors
- **lint:fix**: Fixes the lint errors that can be resolved automatically
- **coverage**: Runs the tests for the contracts and creates a report
## Licensing
The entire app is licensed as `AGPL-3.0-or-later`.