Skip to content

Commit

Permalink
Add a bit more contribution detail
Browse files Browse the repository at this point in the history
  • Loading branch information
Gordon Shotwell committed Dec 7, 2023
1 parent 7a7556d commit 6a1517c
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,37 @@ The frameworks we have so far are:

## Running the examples

Navigate to the example folder and install the dependencies in a virtual environment with
- Each solution is contained within its own folder, one folder per framework
- To run a solution, navigate to its folder and install requirements with `pip install -r requirements.txt`
- Run the app with the framework-specific command listed above


``` bash
pip install -r requirements.txt
```

| Framework | Command |
|-----------|------------------------|
| Dash | `python app.py` |
| Panel | `panel serve app.py` |
| Streamlit | `streamlit run app.py` |
| Shiny | `shiny run app.py` |
| Framework | Command |
|-----------|------------------------------------------|
| Dash | `python app.py` |
| Panel | `panel serve app.py` |
| Streamlit | `streamlit run app.py` |
| Shiny | `shiny run app.py --launch-browser` |

# Contributing

We welcome contributers of all forms, there is no real build process this repo, and submissions will be evaluated manually.

# Submitting a new problem
## Submitting a new problem

Please raise an issue to discuss and clarify the problem statement, and then submit a pull request with the problem statement in a README file.
Ideally problems should have the following qualities:

- Problems should be small and clear

- Successful apps should stand alone and not require external APIs or system setup

- Problems should focus on the capabilities of the web framework

- For inspriation see [7guis](https://eugenkiss.github.io/7guis/) or [TodoMVC](https://todomvc.com/)

# Submitting a new solution
## Submitting a new solution

We want only one solution per framework, but please submit PRs with either solutions from a new framework, or improvements to an the existing solution.
Your solution should focus on the framework's capabilities, and ideally have fairly few dependencies.
Expand Down

0 comments on commit 6a1517c

Please sign in to comment.