0.4.0 • Published 10 months ago

kiwistand v0.4.0

Weekly downloads
-
License
GPL-3.0-only
Repository
github
Last release
10 months ago

attestate/kiwistand

Node.js CI

kiwistand is a p2p node client for a web3 writer friendly Hacker News that nobody controls but everybody co-owns

installation

It is required to have installed:

  • node >= v16
git clone git@github.com:attestate/kiwistand.git
cp .env-copy .env
npm i
# and then for the frontend
cd src/web && npm i &&& cd ../..
npm run dev:anon
# might error when trying to create the data dir, that's a bug right now, just run it again

If your Ethereum RPC node is behind a reverse proxy with Authorization requirements, consider adding the @attestate/crawler RPC_API_KEY environment variable (details).

docs

We document the code base in Sphinx, see ./docs. We host the documentation at attestate.com/kiwistand/main.

tech stack details

node operators

Since https://news.kiwistand.com is now running live as a p2p node, you're invited to run your own nodes and frontends. However, please consider to join a chat like the attestate dev chat to stay in touch for eventual upgrade announcements as the protocol is far from being complete.

changelog

See changelog.md file.

roadmap

Here is the Roadmap file we try to keep updated weekly. If not message @timdaub (e.g. on Telegram).

license

GPL-3.0-only, see LICENSE file