Skip to content

Latest commit

 

History

History
52 lines (45 loc) · 1.53 KB

DEVELOPMENT.md

File metadata and controls

52 lines (45 loc) · 1.53 KB
Raw

Development of streamlit-webrtc

Development

  • Edit streamlit_webrtc/__init__.py to set _RELEASE = False in order to show the frontend view served from a development server as below instead of the production build.
    • Do not commit this change. This setting is only for development.
    • If _RELEASE = False is set, the build command fails, which is described in the next section. See the pkg/build rule in Makefile and release_check.py for the details.
  • Run the frontend dev server 
    $ cd streamlit_webrtc/frontend
$ npm start
  • In another shell, run app.py 
    $ streamlit run home.py

If you want to use Docker

Build the image:

make docker/build

Run the sample app:

make docker/run

Log in to the shell:

make docker/shell

Release

  1. Edit CHANGELOG.md and commit it.
  2. Set the next version with the following command, which updates the package version defined in pyproject.toml and creates a new Git tag representing this release. 
    $ ./scripts/bump-version.sh <version>
    NOTE: patch, minor, or major can be used as <version>.
  3. Push the commit with the tag to GitHub. After pushing the tag, CI/CD automatically deploys the release. 
    $ git push
$ git push --tags

Build

The following command is run to build the package during the automated release process in CI/CD described above. When you want to run the build locally for development or test, you can directly use this command.

$ make pkg/build