|
1 | 1 | # SimWrapper Example Project |
2 | 2 |
|
3 | | -These files show some examples of some of the things you can do with SimWrapper. Check out the full docs at https://simwrapper.github.io |
| 3 | +These files provide examples of some of the things you can do with SimWrapper. Check out the full docs at https://simwrapper.github.io |
4 | 4 |
|
5 | | -## Viewing these files locally |
| 5 | +- Make a local clone of this repo on your computer. |
6 | 6 |
|
7 | | -SimWrapper is at https://simwrapper.github.io/site |
| 7 | +- Browse to https://simwrapper.github.io/site |
8 | 8 |
|
9 | | -- If you're using Google Chrome or MS Edge, you can click "Add Folder" on the main |
10 | | - SimWrapper page, browse to this folder, and give Chrome read access to this folder |
| 9 | +- If you're using **Google Chrome or MS Edge**, you can click "Add Folder" on the main SimWrapper page, browse to the `data` folder in your clone, and give Chrome read access to it. |
11 | 10 |
|
12 | | -- For Firefox/Safari, you can view local folders by running either |
13 | | - - `java -jar mini-file-server.jar` in this folder; or |
| 11 | +- For **Firefox/Safari,** you need to install a little helper app that enables those browsers to view local files. You can run either |
| 12 | + - `java -jar mini-file-server.jar` in your cloned folder; or |
14 | 13 | - `simwrapper serve` to run the python tool (use `pip install simwrapper` first) |
| 14 | + - Both tools simply provide a tiny file server on localhost:8080 that serves up files & folders in the directory in which it was started. |
| 15 | + - Now you can go to https://simwrapper.github.io/site/local/ to see the data files. |
15 | 16 |
|
16 | | -Note that you have to reload your browser after you change any local files on your computer; |
17 | | -all browsers cache results and won't show your changes until you click reload. |
| 17 | +## Instructions for hosting SimWrapper projects on the web using fly.io |
18 | 18 |
|
| 19 | +You can host your project site easily on the web, using https://fly.io which has a nice free tier up to 5GB (check their pricing for details) |
19 | 20 |
|
20 | | -## Instructions for hosting SimWrapper on fly.io |
| 21 | +First time setup: |
21 | 22 |
|
22 | | -You can host your files on the web easily using https://fly.io |
23 | | - |
24 | | -- Install `flyctl` tool from https://fly.io |
| 23 | +- Install `flyctl` tool from https://fly.io/docs/hands-on/installing/ |
25 | 24 | - Run `flyctl auth signup` once to get a free account |
26 | | -- Copy your data files into the `data` folder here |
27 | | -- run `flyctl launch` |
| 25 | + |
| 26 | +Then: |
| 27 | + |
| 28 | +- Copy your own files & folders into the `data` folder, or edit the example files as a test first |
| 29 | +- run `flyctl launch` and answer the prompts. |
28 | 30 |
|
29 | 31 |
|
0 commit comments