Commit graph

5 commits

Author SHA1 Message Date
e3eba93f4e
docs: remove redundant 'plugins' line in README
The 'plugins = python3' line in the uwsgi.ini example should be unnecessary when installing uwsgi from pip. This simplifies the configuration instructions and avoids potential confusion for users.
2024-09-26 07:52:06 +02:00
907df9dc1f
fix(docs): clarify proxy fix usage with reverse proxies
Added additional context to the explanation of the ProxyFix middleware in the README. It now details how to recognize issues with the `X-Forwarded-Host` header, such as the URL displaying internal IP and port instead of the domain name. This improvement helps users better understand when to enable the `PROXY_FIX` environment variable.
2024-09-26 07:45:52 +02:00
c67746ea89
feat: enhance deployment and proxy support
- Updated README to include detailed production deployment steps using uWSGI and Caddy for better performance and scalability.
- Added setup instructions for local development.
- Integrated ProxyFix middleware in the app to handle headers from reverse proxies, improving compatibility with various proxy setups.

Addresses better production readiness and proxy configuration.
2024-09-26 07:44:10 +02:00
d09267cd6c
docs: update features in README
Added details on image proxying and GitHub gists embedding to the README. Clarified iframe loading behavior to improve documentation regarding user consent. This makes the README more comprehensive and informs users about these functionalities.
2024-09-19 18:56:28 +02:00
675f5195fe
feat: initialize project structure for Small
Add initial project structure for Small, a clean frontend for reading Medium articles. This setup includes:

- Basic Flask app configuration with necessary dependencies.
- RESTful endpoint to fetch and serve Medium articles.
- Templates and static assets for the user interface.
- Utility functions for parsing Medium article IDs.
- Custom error pages (404 and 500) for nicer error handling.
- Project metadata files such as .gitignore, README, LICENSE, and pyproject.toml for project setup and documentation.

This structure sets the foundation for further development and feature additions.
2024-09-19 09:14:05 +02:00