mirror of
https://github.com/marcogll/soul23_placeholder_site_server.git
synced 2026-01-13 13:25:18 +00:00
feat: Introduce a Python health checker, reorganize static assets and data, and remove Zsh helper scripts.
This commit is contained in:
15
data/README.md
Normal file
15
data/README.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Data Files
|
||||
|
||||
This directory contains various data files used by the application.
|
||||
|
||||
## Organization
|
||||
|
||||
* `quotes.json`: Stores a collection of phrases for the `/day-quote` endpoint.
|
||||
* Other `.json` files: Should contain structured data for specific application features.
|
||||
* Avoid storing large binary files directly in this directory; consider external storage solutions or dedicated asset folders for those.
|
||||
|
||||
## Best Practices
|
||||
|
||||
* Ensure all data files are in a structured, easily parsable format (e.g., JSON, YAML).
|
||||
* Provide a clear description for each data file, either in comments within the file (if the format supports it) or in this README.
|
||||
* Do not store sensitive information in plaintext here. Use environment variables or a secure configuration management system for secrets.
|
||||
Reference in New Issue
Block a user