myriad

flask app for plurals to publicly share member lists

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
ALLOWED_EXTENSIONS = {'png', 'jpg', 'jpeg', 'gif'}
ICON_UPLOAD_FOLDER = 'myriad/static/icons'
BLINKIES_UPLOAD_FOLDER = 'myriad/static/blinkies'
STAMPS_UPLOAD_FOLDER = 'myriad/static/stamps'

• registration should only be set to True in a development situation (in production set it to False one you have set up your administration account). this would mean that anyone can make an account and edit your system
• feel free to adjust allowed file extensions however you choose
• upload folders don't need to be changed

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