xppl/README.md

49 lines
842 B
Markdown
Raw Normal View History

# Varia's XPPL
2018-05-20 00:10:01 +02:00
The [XPUB] library living at [Varia].
2018-05-20 00:10:01 +02:00
> https://books.vvvvvvaria.org/
2018-07-20 13:53:37 +02:00
2018-11-18 11:14:52 +01:00
[XPUB]: http://xpub.nl/
[Varia]: https://varia.zone/
2018-07-20 13:53:37 +02:00
# Hack It
2018-05-20 00:10:01 +02:00
You'll need to run an [RQLite] database first:
2018-11-18 11:14:52 +01:00
```
$ apt update && apt install -y make
$ make install-rqlite
$ make rqlited
2018-11-18 11:14:52 +01:00
```
Then get [Pipenv] and run the development server with:
2018-05-20 00:10:01 +02:00
```bash
$ pipenv install --dev --three
$ pipenv run devserver
```
2018-05-20 00:10:01 +02:00
If you need to check the database contents, run:
```bash
$ make rqlite
```
And then run `.help` for which commands are available.
[Pipenv]: https://pipenv.readthedocs.io/en/latest/install/#pragmatic-installation-of-pipenv
2018-11-18 11:14:52 +01:00
[RQLite]: https://github.com/rqlite/rqlite
2018-05-20 00:10:01 +02:00
# Test It
```bash
$ pipenv run tox
```
Refer to the [tox.ini](tox.ini) for configuration options.
# Deploy It
2018-07-20 13:53:37 +02:00
See [ansible/README.md](ansible/README.md) for this.