https://github.com/widgetti/solarathon
Template project for Solarathon 2023
https://github.com/widgetti/solarathon
Last synced: 6 months ago
JSON representation
Template project for Solarathon 2023
- Host: GitHub
- URL: https://github.com/widgetti/solarathon
- Owner: widgetti
- License: mit
- Created: 2023-11-20T13:31:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-07T21:49:49.000Z (over 2 years ago)
- Last Synced: 2025-04-19T03:33:43.846Z (about 1 year ago)
- Language: Python
- Size: 5.86 KB
- Stars: 5
- Watchers: 1
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Install locally
```
pip install -e .
```
# Run locally
```
$ solara run solarathon.pages
# add --no-open if you don't like opening the browser window automatically
```
# Deploy via Github Actions
[Get your Ploomber API key](https://docs.cloud.ploomber.io/en/latest/quickstart/apikey.html) and set it as `PLOOMBER_CLOUD_KEY` in GitHub (under Settings->Secrets and Variables->Actions, and click "New repository secret")
## Do only once
* [Sign up for Ploomber](https://www.platform.ploomber.io/register/)
* [Get the API key](https://docs.cloud.ploomber.io/en/latest/quickstart/apikey.html) from [The Ploomber dashboard](https://platform.ploomber.io/)
```
$ ploomber-cloud key YOURKEY
$ (cd ploomber && rm ploomber-cloud.json && ploomber-cloud init)
(add to git and commit)
$ git add ploomber/ploomber-cloud.json
$ git commit -m "ci: set ploomber id"
$ git push origin master:ploomber
```
## Run to deploy a new version
```
$ git push origin master:ploomber
# add --force if needed
```
# Other resources
* [Wanderlust app](https://github.com/widgetti/wanderlust)
* [Solara website](https://github.com/widgetti/solara/tree/master/solara/website)
* [Solara examples](https://solara.dev/examples)
# Deploy manually
(Not recommended)
See https://docs.cloud.ploomber.io/en/latest/user-guide/cli.html for more details
```
$ pip install ploomber-cloud
$ mkdir -p ploomber/wheels
$ ploomber-cloud key YOURKEY
$ (cd ploomber && ploomber-cloud init)
(type y)
# build the wheel
$ (hatch build && cp dist/*.whl ploomber/wheels)
$ (cd ploomber && ploomber-cloud deploy)
```