Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raymondberg/secret_wiki

A wiki designed for telling stories and keeping secrets as you do.
https://github.com/raymondberg/secret_wiki

dungeons-and-dragons storytelling tabletop-gaming wiki

Last synced: 11 days ago
JSON representation

A wiki designed for telling stories and keeping secrets as you do.

Awesome Lists containing this project

README

        

# SecretWiki

A wiki for sharing data...and secrets.

## Use-Case

If you've ever played a Tabletop RPG you know that there's a lot of information
that needs to get collected and maintained over a game. Characters, locations,
plot points, you name it! But how do you keep track of it all without managing
a public copy for your users and a private copy for yourself? Pay for an
expensive public service? No. Use SecretWiki.

# Usage

This repo follows Github's Scripts To Rule them All. These scripts will do everything you need to start

```
script/setup
script/test

# Build front-end components AND start webserver
script/server

# If you are doing extensive work in the frontend, you can run it separately
# and get on-write-refreshes rather than rerunning script/update
script/server --frontend

# Or you can just build the front-end components as you need
script/update
```

## Provisioning

You must create users using the console at this time. A helper function
exists to make this easier. You can just call the function or provide inputs
to configure the user:

```
script/shell

> create_user(email="[email protected]", password="person", is_superuser=False)
```

`is_superuser` is what is what determines "global readability" of secrets.
You cannot keep a secret from a superuser.