myriad/README.md

# myriad

flask app for plurals to publicly share member lists

# todo (minor)

- add delete button to blog posts on main feed
- show blog posts in edit member section with a delete button

# todo (major)

- add blinkies and stamps sections to member pages
- (require above) add blinkies and stamps upload sections to edit member page
- (require above) add blinkies and stamps link/db cleanup to manage site assets

# dev set up (windows)

- 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`

do not deploy this way, the packaged flask server is not secure. production instructions will be provided when the project is ready

- you will need to run `.venv\Scripts\activate` from the folder every time you start working on it
- re-building the entire database with `flask --app myriad init-db` (losing all the data inside) will be necessary as development continues. DO NOT STORE ANYTHING IMPORTANT DURING DEVELOPMENT
- start the site with `flask --app myriad run --debug` as usual

# prod set up

- not ready yet

# config

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

```
REGISTRATION = True # Make sure to disable in production
ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif'} # Can be anything you want
ICON_UPLOAD_FOLDER = 'myriad/static/icons' # where member icons will be stored
BLINKIES_UPLOAD_FOLDER = 'myriad/static/blinkies' # where site assets "blinkies" will be stored
STAMPS_UPLOAD_FOLDER = 'myriad/static/stamps' # where site assets "stamps" will be stored
INLINE_UPLOAD_FOLDER = 'myriad/static/inline' # where site assets "misc inline" will be stored
MISC_UPLOAD_FOLDER = 'myriad/static/misc' # where other small images will be stored
```

# 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