-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
Devcontainer backend dev #608
Devcontainer backend dev #608
Conversation
@@ -6,7 +6,7 @@ | |||
"version": "latest" | |||
} | |||
}, | |||
"postCreateCommand": "bash .devcontainer/frontend/post_create_command.sh", | |||
"postCreateCommand": "bash .devcontainer/backend-dev/post_create_command.sh", |
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.
Why are we renaming this file?
Just a doubt, best of intentions.
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.
Just to be a little more consistent or inline with naming conventions in here. https://github.com/LAION-AI/Open-Assistant/blob/main/docker-compose.yaml
And try minimize any risk of someone confusing it with maybe some more prod ready "backend" devcontainer that maybe we could end up wanting to make in future.
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.
Oh the commit above is a relative path that needed to change.
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
backend-dev
devcontainer in.devcontainer/backend-dev
.devcontainer/backend-dev/post_create_command.sh
to try automate some of the set up steps from backend/README.mdopenapi.json
from local running fastapiwget localhost:8080/api/v1/openapi.json -O docs/docs/api/openapi.json
to save openapi.json todocs/docs/api/
You can see example of the openapi.json here from my branch: https://editor.swagger.io/?url=https://raw.githubusercontent.com/andrewm4894/Open-Assistant/devcontainer-backend-dev/docs/docs/api/openapi.json
unfortunately its still manual for now but am sure we can try automate the production of
docs/docs/api/openapi.json
maybe via a GH action at some stage.