Skip to content

Commit

Permalink
minor readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
javierluraschi committed Mar 4, 2024
1 parent 4f31d04 commit 6b5e016
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,46 +33,46 @@ streamlit run app.py

![](images/carousel.png)

A file with all components is available in [examples/all.py](example/app.py):
A file with all components is available in [examples/all.py](examples/app.py):

![](images/components.png)

Take a look at [Buefy Documentation](https://buefy.org/documentation) for a list of all properties and examples available.
Take a look at [Buefy's documentation](https://buefy.org/documentation) for a list of all properties and examples available.

[![](images/buefy.png)](https://buefy.org/documentation)

## Contributing

- Ensure you have [Python 3.6+](https://www.python.org/downloads/), [Node.js](https://nodejs.org), and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed.
- Clone this repo.
- Create a new Python virtual environment for the template:
Ensure you have [Python 3.6+](https://www.python.org/downloads/), [Node.js](https://nodejs.org), and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed.

Clone this repo and create a new Python virtual environment:

```
$ python3 -m venv venv # create venv
$ . venv/bin/activate # activate venv
$ pip install streamlit # install streamlit
```

- Initialize and run the component template frontend:
Initialize and run the component frontend:

```
$ cd streamfy/frontend
$ npm install # Install npm dependencies
$ npm run serve # Start the Webpack dev server
```

- From a separate terminal, run the template's Streamlit app:
From a separate terminal, run the Streamlit app:

```
$ . venv/bin/activate # activate the venv you created earlier
$ streamlit run streamfy/__init__.py # run the example
```

- If all goes well, you should see something like this:
![Quickstart Success](images/development.png)
- Modify the frontend code at `streamfy/frontend/src/Streamfy.vue`.
- Parameters passed by Python script are made available in `args` props.
- Modify the Python code at `streamfy/__init__.py`.
If all goes well, you should see something like this:

![](images/development.png)

Modify the frontend code at `streamfy/frontend/src/Streamfy.vue` and the Python code at `streamfy/__init__.py`.

## Resources

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setuptools.setup(
name="streamfy",
version="0.2.1",
version="0.2.2",
author="",
author_email="",
description="",
Expand Down

0 comments on commit 6b5e016

Please sign in to comment.