Merge pull request #8 from skftn/update-readme

Updating settings & README
This commit is contained in:
xmrdsc 2018-10-20 00:01:06 +02:00 committed by GitHub
commit 75c7f49842
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 14 deletions

View file

@ -1,26 +1,64 @@
# WOW funding
# Wownero Funding System
## installation (locally)
![whoop](https://i.imgur.com/xVS3UGq.png)
Create a Postgres user/database for this project
A simple Flask application for managing donations.
Example
-------
[https://funding.wownero.com](https://funding.wownero.com)
## Installation
Good luck with trying to get this to run! Some pointers:
#### Daemon
First make sure the daemon is up.
```bash
./wownerod --max-concurrency 4
```
#### Wallet RPC
Expose wallet via RPC.
```bash
./wownero-wallet-rpc --rpc-bind-port 45678 --disable-rpc-login --wallet-file wfs --password ""
```
#### Web application
Download application and configure.
```
sudo apt install python-virtualenv python3 redis-server postgresql-server-dev-*
git clone ...
cd ffs_site
sudo apt install python-virtualenv python3 redis-server postgresql-server postgresql-server-dev-*
git clone https://github.com/skftn/wownero-wfs.git
cd funding
virtualenv -p /usr/bin/python3
source venv/bin/activate
pip install -r requirements.txt
cp settings.py_example settings.py
- change settings accordingly
```
Prepare a database in postgres and create an user for it.
Run the application:
```bash
python run_dev.py
```
### to-do
Beware `run_dev.py` is meant as a development server.
- rate limit posting of proposals per user
### Contributors
https://imgur.com/KKzFQe9
https://imgur.com/Dl3wRgD
- [camthegeek](https://github.com/camthegeek)
### License
© 2018 WTFPL Do What the Fuck You Want to Public License

View file

@ -14,8 +14,8 @@ PSQL_DB = ''
SQLALCHEMY_DATABASE_URI = os.environ.get('SQLALCHEMY_DATABASE_URI', 'postgresql://{user}:{pw}@localhost/{db}').format(user=PSQL_USER, pw=PSQL_PASS, db=PSQL_DB)
SESSION_COOKIE_NAME = os.environ.get('{coincode}_SESSION_COOKIE_NAME', '{coincode}_id').format(coincode=COINCODE)
SESSION_PREFIX = os.environ.get('{coincode}_SESSION_PREFIX', 'session:').format(coincode=COINCODE)
SESSION_COOKIE_NAME = os.environ.get('{coincode}_SESSION_COOKIE_NAME', '{coincode}_id').format(coincode=COINCODE.upper())
SESSION_PREFIX = os.environ.get('{coincode}_SESSION_PREFIX', 'session:').format(coincode=COINCODE.upper())
REDIS_HOST = os.environ.get('REDIS_HOST', '127.0.0.1')
REDIS_PORT = int(os.environ.get('REDIS_PORT', 6379))
@ -28,7 +28,7 @@ BIND_PORT = os.environ.get("BIND_PORT", 5004)
if not BIND_PORT:
raise Exception("BIND_PORT missing")
HOSTNAME = os.environ.get("{coincode}_HOSTNAME", socket.gethostname()).format(coincode=COINCODE)
HOSTNAME = os.environ.get("{coincode}_HOSTNAME", socket.gethostname()).format(coincode=COINCODE.upper())
# If using a local RPC, no need for --rpc-login credentials unless you're binding wallet-rpc to 0.0.0.0. If you are, you're bad.
# elif, remote wallet-rpc, enable --rpc-login and enter credentials below.
@ -79,4 +79,4 @@ What will be delivered? What goals will be reached?
#### Why you?
What skills and experience do you have?
""".strip().format(coincode=COINCODE)
""".strip().format(coincode=COINCODE.upper())