Skip to content

Conversation

vanessavmac
Copy link
Collaborator

@vanessavmac vanessavmac commented Sep 4, 2024

  • Automatically redirect the backend API to api/v2 and remove /home and /about pages.
  • Add instructions about installing pre-commit
  • Fix UI container in docker compose stack

@vanessavmac vanessavmac requested a review from mihow September 4, 2024 13:11
@vanessavmac vanessavmac self-assigned this Sep 4, 2024
@vanessavmac vanessavmac linked an issue Sep 4, 2024 that may be closed by this pull request
Copy link

netlify bot commented Sep 4, 2024

Deploy Preview for ami-storybook canceled.

Name Link
🔨 Latest commit 1ac40b4
🔍 Latest deploy log https://app.netlify.com/sites/ami-storybook/deploys/66e89d71aff95900085f0c05

Copy link

netlify bot commented Sep 4, 2024

Deploy Preview for ami-dev canceled.

Name Link
🔨 Latest commit 1ac40b4
🔍 Latest deploy log https://app.netlify.com/sites/ami-dev/deploys/66e89d7155ac79000868dd2a

@mihow
Copy link
Collaborator

mihow commented Sep 5, 2024

@vanessavmac Thank you! see the failed backend tests. It looks like it's failing the code formatting. Are you using VSCode? The project should suggest the installation of Black & auto-format on save. So you can fix those linting & formatting locally before pushing. Also! There is a pre-commit hook to check the linting & formatting before committing changes. That should be installed as part of the project setup.

Will you add instructions about installing pre-commit and running pre-commit install? The pre-commit package is usually installed as part of your system python packages (vs. the local virtualenv).
https://pre-commit.com/

@vanessavmac
Copy link
Collaborator Author

@mihow Thanks for the comments!

Backend tests now pass and I added instructions to the README about installing the backend packages for IDE support + configuring pre-commit.

docs: update instructions about pre-commit and backend dependencies
fix: make homepage redirect a temporary redirect because the API version will change
config/urls.py Outdated
path(API_ROOT + "schema/", SpectacularAPIView.as_view(api_version="api"), name="api-schema"),
path(
"api/v2/docs/",
API_ROOT + "docs/",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

urljoin() is a safer choice for url concatenation.

@vanessavmac vanessavmac requested a review from mihow September 16, 2024 19:23
@mihow mihow changed the title 533 test readme initial project setup Updates to README and initial project setup Sep 16, 2024
Copy link
Collaborator

@mihow mihow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Vanessa for improving our initial project setup!

@mihow mihow merged commit 2819b26 into main Sep 16, 2024
6 checks passed
@mihow mihow deleted the 533-test-readme-initial-project-setup branch September 16, 2024 21:09
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.

Test README & initial project setup
2 participants