Suggested changes based on my setup experience #945
+38
−12
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.
Hi
I try myself at the froide development setup right now.
While doing this, I try to improve the documentation.
Proposed changes so far:
because they puzzled me
because this allows me to avoid a system wide installation of ruff, which is needed for
make test
because it was outdated and incomplete
because its tedious to find out one after another
it was outdated and it would only get outdated again
pnpm install
andpnpm run build
failed at the exifeader postinstall script until I also installed node 20 and npm.Any ideas how to get by only with @pnpm/exe ?
After running the manage.py setup steps:
make test
failed on 31 tests. See test-summary.txtpytest --create-db
once,make test
runs green.Since
pytest --create-db
needs to run after each database schema change (see pytest-django docs: Example work flow with --reuse-db and --create-db), this could become another make target.Of all the system dependencies that are installed in 'Froide CI', I only installed 'libpoppler-cpp-dev' so far.
I propose to add a make target 'setup' and reference it from the readme. I think this would be less likely to become outdated.
I also plan to update the documentation. First of all docs/development.rst which seems to be completely outdated.
Please give feedback if this is helpful to you and give pointers what else is important for development setup.