myriad/README.md

# myriad

flask app for plurals to publicly share member lists

# dev set up 

- after cloning, run `py -3 -m venv .venv` in the root directory and then `.venv\Scripts\activate`
- then `pip install Flask` inside the virtual env
- you might also need to init a database, so use `flask --app myriad init-db`
- to start the site use `flask --app myriad run --debug`

# prod set up

- not ready yet

# config

- create `config.py` in the instance folder and customise the following settings to your needs

```
REGISTRATION: False # only set to True if in a development situation, or to create your first user
UPLOAD_FOLDER = 'myriad/static/icons'
ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif'}
```

# usage

- the software here is free to use, and there's no requirement to link back
- edit the styles and functionality to suit your needs. i'm sure some of you out there are far better with CSS than I am 

# dependencies

- Flask