chore: make hosts configurable and enrich project documentation #65
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit enhances security by replacing the wildcard `ALLOWED_HOSTS` setting with a configurable list loaded from the `DJANGO_ALLOWED_HOSTS` environment variable. - The `promo_code/settings.py` file now parses a comma-separated string from the environment variable. - The `.env.example` file has been updated to include `DJANGO_ALLOWED_HOSTS` with a default value of `localhost,127.0.0.1,0.0.0.0`.
This commit introduces comprehensive API documentation and enhances the project's overall documentation. Key additions: - **OpenAPI Specification:** A new `api.yml` file has been added, providing a detailed OpenAPI 3.0 specification for all B2B and B2C endpoints. This includes request/response schemas, parameters, and status codes. - **Database Schema:** New schema diagrams (`black_schema.excalidraw.png` and `white_schema.excalidraw.png`) have been added to the `media/` directory to visualize the database structure. - **README Update:** The `README.md` has been updated to include the new documentation and schema diagrams, providing a more complete project overview.
This commit adds a document emoji to the "API Specification" section header in the `README.md` file to improve visual appeal.
This commit adds GitHub Actions and Ruff status badges to the `README.md` to provide a quick, visible status of the project's CI and code quality.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ALLOWED_HOSTSfromDJANGO_ALLOWED_HOSTSenv var (comma‑separated) inpromo_code/settings.py; update.env.exampleapi.yml) covering all B2B/B2C endpoints, including schemas, parameters, and status codesblack_schema.excalidraw.png&white_schema.excalidraw.png) inmedia/and updateREADME.mdREADME.mdfor CI and linting visibility