Skip to content

Commit

Permalink
Add development document
Browse files Browse the repository at this point in the history
Signed-off-by: Aisuko <[email protected]>
  • Loading branch information
Aisuko committed Jul 9, 2024
1 parent 1f8f2a0 commit 6fac625
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions docs/Development.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Development with Devcontainer
# Development methods

For developer, we encourage you to use the following technologies:
There are two ways to do development:


## Development outside docker

You can't debug step by step in this mode. However, your changed will be deployed automatically by docker compose.

First, please run `make up`, and then use `make log` to stream output logs to the terminal.

Second, edit code with your IDE. And the code will automatically build and run. You can check from the `<deployment-ip>:80` to check the code.


## Development with Devcontainer

For developer, we encourage you to use the following technologies. You can debug step by step and don't need to care about other components' containers.

* VSCode
* Devcontainer
Expand All @@ -10,3 +24,8 @@ There are one step to start the development environment:
. Open the project in VSCode and click on the `Reopen in Container` button.

And VSCode will automatically build the development environment based on our [pre-build images](https://hub.docker.com/r/gclub/skywardai/tags).

And you can check the swagger UI on `<deployment-ip>:8000/docs/`


Happy coding!

0 comments on commit 6fac625

Please sign in to comment.