New README.md & installation scripts now live in the scripts folder.#218
Merged
igorbenav merged 19 commits intobenavlabs:mainfrom Nov 16, 2025
Merged
New README.md & installation scripts now live in the scripts folder.#218igorbenav merged 19 commits intobenavlabs:mainfrom
igorbenav merged 19 commits intobenavlabs:mainfrom
Conversation
…orn and in prod settings. The ones that were on the Gist. Signed-off-by: Carlos Andrés Planchón Prestes <carlosandresplanchonprestes@gmail.com>
… original README.md.
igorbenav
added
documentation
igorbenav
requested changes
Nov 12, 2025
Collaborator
igorbenav
left a comment
igorbenav
left a comment
There was a problem hiding this comment.
Hey @carlosplanchon, thanks for the PR! A few things:
- Files named
envshould be renamed to.env.exampleto follow standard conventions. Also add warning headers indicating these are example values that must be changed (current hardcoded values likeSECRET_KEYand passwords could be accidentally used in production) - All docker-compose files reference
./src/.envbut when copied to root directory per README instructions, this path won't work because of the updates. Need to update paths to../src/.envor adjust the copy workflow - Remove obsolete
version: '3.8'declarations from gunicorn and nginx compose files - Production nginx docker-compose missing web service command directive
- Instructions don't mention copying
default.conffor nginx setup - The copy-paste commands in the README haven't been validated to actually work end-to-end
Plus some branding things (image etc), but I'll add those myself once these issues are fixed
…web service command directive.
…lt.conf for nginx setup.
…o follow standard conventions. Also add warning headers indicating these are example values that must be changed (current hardcoded values like SECRET_KEY and passwords could be accidentally used in production).
…validated to actually work end-to-end.
igorbenav
approved these changes
Nov 16, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adressing this issue: #216