diff --git a/README.md b/README.md index f19c4ec..2687a45 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,37 @@ -# suchwowx +# SuchWowX -Interplanetary Wownero memes launched on [Avalanche network](https://avax.network) and [Interplanetary Filesystem](https://ipfs.io/) +This service is a continuation of SuchWow for the Wownero cryptocurrency project. It has been revamped to use Interplanetary Filesystem, server federation / content sharing, and optionally Avalanche network via a smart contract with some useful features (if you're into that). It's a decentralized application (dApp); it's preferred you run it locally and bootstrap the services on your own machine. ## Setup -https://github.com/ava-labs/avalanchego/ -https://ipfs.io/#install +Tools you will need: +* https://github.com/ava-labs/avalanchego/ +* https://ipfs.io/#install +* python3 (linux os will have this) + +I have provided a `Makefile` with some helpful stuff...make sure to install `make` to use it. + +``` +# install python virtual environment and install application dependencies +make setup + +# install ipfs +make install-ipfs + +# optional: install avalanchego +make install-avax + +# run ipfs +make run-ipfs + +# optional: run avalanchego +make run-avax + +# initialize sqlite database w/ schema via alembic +make init + +# run development server +make dev + +# access at http://127.0.0.1:5000 +```