Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme and create sample env file for local dev #5651

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

baarkerlounger
Copy link
Contributor

@baarkerlounger baarkerlounger commented Sep 20, 2024

Description of change

Make it easier to get a fully local (non-dockerised) setup up and running

  • Clarifies and updates readme steps
  • Separates sample env files into docker and local dev specific ones for easier startup
    • This has the downside of needing to maintain 2 files when we add or remove env vars but this usually happens quite infrequently
    • The upside is simpler setup for new comers

Checklist

  • Has this branch been rebased on top of the current main branch?

    Explanation

    The branch should not be stale or have conflicts at the time reviews are requested.

  • Is the CircleCI build passing?

General points

Other things to check

  • Make sure fixtures/test_data.yaml is maintained when updating models
  • Consider the admin site when making changes to models
  • Use select-/prefetch-related field lists in views and search apps, and update them when fields are added
  • Make sure the README is updated e.g. when adding new environment variables

See docs/CONTRIBUTING.md for more guidelines.

Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.36%. Comparing base (d08d132) to head (6c54ca0).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5651      +/-   ##
==========================================
- Coverage   96.37%   96.36%   -0.01%     
==========================================
  Files        1010     1010              
  Lines       23939    23939              
  Branches     2153     2153              
==========================================
- Hits        23071    23069       -2     
- Misses        702      703       +1     
- Partials      166      167       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant