Merged
Conversation
- Install and configure live server - Fix installation requirements - Rationalise git ignore files - Source .env when loading DB
illicitonion
reviewed
Jun 2, 2025
Member
illicitonion
left a comment
illicitonion
left a comment
There was a problem hiding this comment.
Thanks for putting this together!
Some of this is intentional (instructions in codebases get out of sync from reality, and often aren't documented as clearly as we'd like), but I agree this is a pretty big list. Can you revert the changes to the root README.md, and remove the quickstart.sh? Happy to discuss, but "the instructions are in a file other than the root README" feels realistic, "a script assumes docker is installed which isn't documented" feels pretty realistic, and "I'm not quite sure what to put in the .env file" feels annoying but realistic... Otherwise LGTM!
textbook
force-pushed
the
chore/improve-setup
branch
from
92afd29 to
a4e20c3
Compare
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.
Fix some of the initial issues (see 🧵 Slack thread) on starting up the repository. Add quickstart script to the README and:
Rationalise env variable usage
Docker startup in
db/run.shnow usesbackend/.envas an env file, so env var naming follows the container's usageAdd appropriate VS Code configuration
Add missing dependencies
requestsandpsycopg2for Pythonpackage-lock.jsonfile