mirror of
https://github.com/xlorepdarkhelm/numinar-coding-project.git
synced 2026-09-08 21:33:13 -04:00
Added some more details to the readme file.
Signed-off-by: Cliff Hill <xlorep@darkhelm.org>
This commit is contained in:
@@ -16,6 +16,8 @@ There is no login or security in place with this project. However if set up with
|
||||
|
||||
There already is several pieces for helping secure the application on the backend, using the HyperModern Python cookiecutter and the tools it brings into play, however additional systems could be tied into github to help check things further (like New Relic).
|
||||
|
||||
Typically, the database username/password/etc would not be stored in the repo but in a secrets component and loaded separately. This was bypassed this time as that was outside of the scope of this project and was additional overhead to work with.
|
||||
|
||||
### AI Use
|
||||
|
||||
I used AI to stub out a couple of files:
|
||||
@@ -46,6 +48,10 @@ docker compose -f compose.dev.yml up
|
||||
|
||||
This compose file extends the standard compose file, adding in the necessary pieces to make the application usable in a local dev environment. In this configuration, the frontend is accessable from port 3000 like normal, the backend is accessable from port 8000, and postgres DB from 5432. The way this is set up, that command can easily be run in a separate terminal window during development for rapid testing of the piece(s) being worked on. Logging is at Debug level, and SQLAlchemy is set to echo mode, so queries are also logged. Realtime changes are reflected in the application as the code is run, and commands can be run locally from your terminal (like alembic) without needing to shell into the docker image.
|
||||
|
||||
For development builds, running "pre-commit install" inside the backend folder will install the pre-commit components for ensuring the code is good and clean before it gets commited to the repo.
|
||||
|
||||
The `.env.sample` can be copied to `.env` as well in order to get basic environment variables configured. As this is a system that usually has no external means to reach the database (in the production environment) I have left the actual username/password/etc for the database intact in the files in the repo.
|
||||
|
||||
### Diagrams
|
||||
|
||||
Docker Compose Components:
|
||||
|
||||
@@ -11,7 +11,7 @@ class InviteeBase(BaseModel):
|
||||
"""Base schema for Invitee."""
|
||||
|
||||
booking_id: int
|
||||
user_id: int
|
||||
user_email: str
|
||||
|
||||
|
||||
class InviteeCreate(InviteeBase):
|
||||
|
||||
Reference in New Issue
Block a user