Skip to content

docs: update README #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 17, 2025
Merged

docs: update README #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd581ed
docs: update README
ArthurData Jan 16, 2025
c9490f4
docs: correct instructions for creating index.html and add signature …
ArthurData Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ More details on the contest can be found [here](https://posit.co/blog/winners-of
## Demo

🕹️ Try the app at:
[https://connect.thinkr.fr/signature-py/](https://connect.thinkr.fr/signature-py/)
[https://signature-py.vercel.app/](https://signature-py.vercel.app/)

## Try locally

Expand Down Expand Up @@ -78,7 +78,9 @@ sass scss/signature.scss css/signature.css

The redirection banner is a JavaScript function that redirects the user to the specified URL.

To modify the redirection URL, edit the `index.html` file at the root of the project.
To modify the redirection URL, creeate a `index.html` file at the root of the project.

See : [signature](https://github.com/ThinkR-open/signature/)

## Mockup

Expand All @@ -88,18 +90,19 @@ Explore the mockup [here](https://www.figma.com/proto/u95KvEqgWLB8arxt7saZcJ/%7B

## Deployment

The app is deployed on Connect.
The app is deployed on **Vercel**.

Export the signature site using the following command:

```bash
poetry shell
cd signature
rsconnect write-manifest shiny . --overwrite
shinylive export signature site
```

Then update `requirements.txt` :
Then update run the app locally using the following command:

```bash
poetry export --without-hashes --format=requirements.txt > requirements.txt
python3 -m http.server --directory site --bind localhost 8008
```

## Tests
Expand Down
2 changes: 1 addition & 1 deletion site/app.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading