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

Devcontainer backend dev #608

Merged
merged 5 commits into from
Jan 11, 2023

Conversation

andrewm4894
Copy link
Collaborator

@andrewm4894 andrewm4894 commented Jan 10, 2023

  • add backend-dev devcontainer in .devcontainer/backend-dev
  • use .devcontainer/backend-dev/post_create_command.sh to try automate some of the set up steps from backend/README.md
  • add note to backend/README.md on how to grab openapi.json from local running fastapi
  • manually ran wget localhost:8080/api/v1/openapi.json -O docs/docs/api/openapi.json to save openapi.json to docs/docs/api/
  • add API section to docs site that just links out to the swagger.io renderer for now.

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.

@andrewm4894 andrewm4894 marked this pull request as ready for review January 10, 2023 23:09
@andrewm4894 andrewm4894 enabled auto-merge (squash) January 10, 2023 23:29
@fozziethebeat fozziethebeat added the testing all things testing label Jan 10, 2023
@@ -6,7 +6,7 @@
"version": "latest"
}
},
"postCreateCommand": "bash .devcontainer/frontend/post_create_command.sh",
"postCreateCommand": "bash .devcontainer/backend-dev/post_create_command.sh",
Copy link
Contributor

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.

Copy link
Collaborator Author

@andrewm4894 andrewm4894 Jan 11, 2023

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.

Copy link
Collaborator Author

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.

Copy link
Collaborator

@yk yk 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

@andrewm4894 andrewm4894 merged commit b1fbd0f into LAION-AI:main Jan 11, 2023
@andrewm4894 andrewm4894 deleted the devcontainer-backend-dev branch January 11, 2023 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants