vamping readme, adding those pesky footer links, example secrets

pull/3/head
lalanza808 5 years ago
parent d3630d0114
commit 98a6d726f3

@ -0,0 +1,20 @@
DB_PASS=xxxxxxxxxxxxx
DB_USER=xmrauctions
DB_HOST=localhost
DB_NAME=xmrauctions
SECRET_KEY=xxxxxxxxxx
ALLOWED_HOSTS=127.0.0.1,localhost
DAEMON_HOST=xxxxxxxxxxxx
DAEMON_PORT=38081
DAEMON_USER=xxxxxxxxxxx
DAEMON_PASS=xxxxxxxxxxxxx
CACHE_HOST=localhost
WALLET_HOST=localhost
WALLET_PORT=38083
WALLET_USER=xxxxxxxxxx
WALLET_PASS=xxxxxxxxxx
DEBUG=true
# If no DEBUG
AWS_STORAGE_BUCKET_NAME=xxxxxxxxxxxxxx
AWS_S3_CUSTOM_DOMAIN=xxxxxxxxxxxxxxx

@ -1,8 +1,28 @@
# xmrauctions
I'll be filling this in over the following days. Stay tuned.
This is a somewhat simple little CRUD, Django app. It's fairly minimal auction house where you can post items you possess and exchange them with your fellow humans from anywhere around the world.
## Security Go-Live Checklist
Item creation requires you to provide a Monero wallet address. There are many good options, including but not limited to:
* [CakeWallet](https://twitter.com/cakewalletxmr)
* [MyMonero](https://mymonero.com/)
* [Monerujo](https://www.monerujo.io/)
This app is in an alpha stage and is not polished enough to transact real money. Once we make progress on some of the to-do items we will proceed to that.
## Dev
You first need secrets. Copy the example one and fill in your details. You'll need to provide your own node and wallet RPC endpoints or public ones. The `Makefile` provided should be enough for general use. Review that file to see what's happening under the hood.
```sh
cp env.example .env
vim .env
make build
make up
make dev
```
## Go-Live Checklist
In no particular order, nice to haves, and should likely haves:
@ -19,3 +39,4 @@ In no particular order, nice to haves, and should likely haves:
- [ ] Budget alarms
- [ ] Unit Tests
- [ ] DB backups
- [ ] Dockerize wallet to run on other instance

@ -0,0 +1 @@
nobody has asked me anything yet :(

@ -0,0 +1,3 @@
Privacy Policy
I'll do my best, dawg.

@ -0,0 +1,3 @@
Terms and Conditions
You agree to not be an asshole and that nothing that happens on this site is my fault in any way.

@ -159,9 +159,9 @@
<li>&copy; {{ site_meta.name }} 2019. All Rights Reserved.</li>
</ul>
<ul class="copyright">
<li><a href="#">Privacy</a></li>
<li><a href="#">Terms</a></li>
<li><a href="#">FAQ</a></li>
<li><a href="{% static 'privacy.txt' %}">Privacy</a></li>
<li><a href="{% static 'terms.txt' %}">Terms</a></li>
<li><a href="{% static 'faq.txt' %}">FAQ</a></li>
</ul>
</div>
</footer>