-
Notifications
You must be signed in to change notification settings - Fork 5
Updates to README and initial project setup #552
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
Conversation
✅ Deploy Preview for ami-storybook canceled.
|
✅ Deploy Preview for ami-dev canceled.
|
@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 |
@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/", |
There was a problem hiding this comment.
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.
…o 533-test-readme-initial-project-setup
There was a problem hiding this 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!
api/v2
and remove /home and /about pages.