ayo/ayco.io-flask
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme instructions and example config

Browse source
This commit is contained in:
Ayo Ayco 2025-01-19 09:47:59 +01:00
parent bd21e2dacf
commit 966b97f2f0
2 changed files with 39 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -5,6 +5,7 @@
This is the default server running at [https://ayo.ayco.io](https://ayco.io). Its main responsibility is serving static files generated with Astro SSG which I maintain in a [separate project](https://ayco.io/sh/ayco.io-astro). The generated files from that project will populate a `dist` directory in here, which will then be served as-is. This is the default server running at [https://ayo.ayco.io](https://ayco.io). Its main responsibility is serving static files generated with Astro SSG which I maintain in a [separate project](https://ayco.io/sh/ayco.io-astro). The generated files from that project will populate a `dist` directory in here, which will then be served as-is.
Additional features are: Additional features are:
1. attach [/threads](https://ayco.io/sh/threads) flask blueprint behind `/threads` route 1. attach [/threads](https://ayco.io/sh/threads) flask blueprint behind `/threads` route
1. perf monitoring and error tracking with [sentry.io](https://sentry.io) 1. perf monitoring and error tracking with [sentry.io](https://sentry.io)
@ -38,13 +39,17 @@ Additional features are:
# activate python env: # activate python env:
$ . .venv/bin/activate $ . .venv/bin/activate
# install wheel: # install dependencies:
(.venv)$ python -m pip install -r requirements.txt (.venv)$ python -m pip install -r requirements.txt
# create configuration from example config file
(.venv)$ cp ./example_config.json ./config.json
# rejoice! # rejoice!
``` ```
3. To start development, run the following: 3. To start development, run the following:
```bash ```bash
(.venv)$ flask --app web.py --debug run (.venv)$ flask --app web.py --debug run
``` ```
@ -53,7 +58,7 @@ Additional features are:
4. Populate a `dist` directory with static files (e.g., `*.html` for pages). Currently I generate static files in a separate [Astro site project](https://ayco.io/sh/ayco.io-astro) -- see instructions on how to set it up separately, run the build script and copy the `dist` here. 4. Populate a `dist` directory with static files (e.g., `*.html` for pages). Currently I generate static files in a separate [Astro site project](https://ayco.io/sh/ayco.io-astro) -- see instructions on how to set it up separately, run the build script and copy the `dist` here.
4. After development session, deactivate the python env 5. After development session, deactivate the python env
```bash ```bash
(.venv)$ deactivate (.venv)$ deactivate
``` ```

6
example_config.json
View file

@ -10,7 +10,10 @@
"site_name": "Thoughts", "site_name": "Thoughts",
"title": "Thoughts", "title": "Thoughts",
"description": "Hand-picked public posts from my social feed", "description": "Hand-picked public posts from my social feed",
"server" : "https://social.ayco.io" "server": "https://social.ayco.io",
"user": "user@mastodon.social",
"password": "ultraelectromagneticpassword",
"secret_file": "threads-masto-client.secret"
} }
}, },
"CACHE_TYPE": "SimpleCache", "CACHE_TYPE": "SimpleCache",
@ -21,4 +24,3 @@
"year": "2022" "year": "2022"
} }
} }