2026-03-15 23:16:24 +00:00
# myriad
2026-03-16 01:39:00 +00:00
flask app for plurals to publicly share member lists
2026-03-20 02:19:39 +00:00
logged in users are presumed to all be admins with distinction only between being logged in and not
2026-03-20 19:27:01 +00:00
in the blog view, member privacy outweighs individual post privacy. if a private member makes a public post, it will not show up in the public feed. however, if that member switches to public, their public posts will all become publicly viewable (but private posts will remain private).
2026-03-17 13:26:49 +00:00
# dev set up (windows)
2026-03-16 01:39:00 +00:00
2026-03-16 01:39:43 +00:00
- 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`
2026-03-16 13:11:56 +00:00
- to start the site use `flask --app myriad run --debug`
2026-03-17 13:26:49 +00:00
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
2026-03-16 13:11:56 +00:00
# prod set up
- not ready yet
# config
2026-03-17 02:01:14 +00:00
- create `config.py` in the instance folder and customise the following settings to your needs
2026-03-16 13:11:56 +00:00
```
2026-03-18 02:36:25 +00:00
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
2026-03-20 23:13:52 +00:00
THEMES_FOLDER = 'myriad/static/themes' # where theme choices will be stored
2026-03-16 13:11:56 +00:00
```
# 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
2026-03-19 02:56:39 +00:00
- Flask
# preview
2026-03-19 03:05:22 +00:00
- these screenshots are all from the public viewer's perspective
2026-03-19 02:56:39 +00:00
- homepage with pinned members
2026-03-19 03:05:22 +00:00
- main blog post feed
- member page showing their uploaded icons (just about)
- groups view
- a sample part of the administration
- the theme editor is pretty ugly right now but it does work
