|
1 | | -# Pittsburgh Lenten Fish Fry Map |
2 | | - |
3 | | -The Pittsburgh Lenten Fish Fry Map is the brainchild of [Hollen Barmer](https://twitter.com/hollenbarmer), who has tirelessly dedicated her time since 2012 inventorying the rich array of Lenten Fish Fry events that occur every spring in Western Pennsylvania. Code for Pittsburgh helps with website development, hosting, and data maintenance! |
4 | | - |
5 | | -## Where Does the Fish Fry data shown on the map come from? |
6 | | - |
7 | | -The raw data isn't here! That is by design. The map gets data from the Fish Fry API @ [fishfry.codeforpgh.com/api/fishfries](http://fishfry.codeforpgh.com/api/fishfries). Anyone can use that URL to get data to make their own fish fry map, or do things with the Fish Fry data that we haven't thought of. If you want to learn more about the database and API, head over to the [Fish Fry Form](https://github.com/CodeForPittsburgh/fishfryform) repository. |
8 | | - |
9 | | -Occassional snapshots of the data from are being dumped into the `data` folder of this repo, but only for posterity. |
10 | | - |
11 | | -## Development |
12 | | - |
13 | | -This is a static web site. We're serving it up with GitHub pages, but it can run on any web server as-is, really. |
14 | | - |
15 | | -### Prerequisites |
16 | | - |
17 | | -To develop this, you have [NodeJS](https://nodejs.org/en/) installed, such that you can call `node` and `npm` from the command line. |
18 | | - |
19 | | -Then, in the root of this directory, run: |
20 | | - |
21 | | -`npm install` |
22 | | - |
23 | | -This will use the `package.json` file to get and install NodeJS dependencies locally, in a `node_modules` folder. |
24 | | - |
25 | | -You will also need these things (available on [NPM](https://www.npmjs.com)): |
26 | | - |
27 | | -* [GulpJS](https://www.npmjs.com/package/gulp), with `gulp` callable from the command line. Install with `npm install gulp@4.0 -g` |
28 | | -* [Http-Server](https://www.npmjs.com/package/http-server), with `http-server` callable from the command line. Install with: `npm install http-server -g` |
29 | | - |
30 | | -Those two things need to be available globally. the `-g` flag in those commands makes sure of that. |
31 | | - |
32 | | -### Building and Watching |
33 | | - |
34 | | -GulpJS is a task-runner that compiles and bundles source code from `src` folder into the `assets` folder. Since the deployment path for this is GitHub pages, we put things into the `assets` folder, which is where Jekyll, the software that runs GitHub pages, expects those things to be. |
35 | | - |
36 | | -We run those tasks with `npm` scripts. |
37 | | - |
38 | | -Running `npm run build` will compile and bundle the source code one time. |
39 | | - |
40 | | -Running `npm run dev` will do that, plus run `http-server`, open the site in a web browser at [http://localhost:3000](http://localhost:3000), and, upon detecting changes to files in `src`, re-runs compiling/bundling and refreshes your browser. Nice! |
41 | | - |
42 | | -If the site doesn't load after `pnpm run dev`, check [http://localhost:4000](http://localhost:4000) in your browser. This is where `http-server` lives. If you don't see anything there, make sure you can run `http-server` from the command line (see **prerequisites** above). |
43 | | - |
44 | | -### Where the functionality lives / where you can hack on the code |
45 | | - |
46 | | -Most of the work is happening in `src/js/app.js`. The rest happens in `index.html`. |
47 | | - |
48 | | -> TODO: the source code for this app is a bit of a mess...the result of quick prototyping. |
49 | | -
|
50 | | -### Deploying this Site |
51 | | - |
52 | | -Run `npm run build`, commit changes, and push as-is to GitHub to deploy. |
53 | | - |
54 | | -## Credits |
55 | | - |
56 | | -The Fish Fry Map is built and maintained by members of Code for Pittsburgh. |
57 | | - |
58 | | -It started with <a href='https://github.com/bmcbride/bootleaf'>Bootleaf</a> (which we've adapted it and modified heavily for this project), and uses <a href="http://getbootstrap.com/">Bootstrap 3</a>, <a href="http://leafletjs.com/" target="_blank">Leaflet</a>, and <a href="http://twitter.github.io/typeahead.js/" target="_blank">typeahead.js</a>, among other things. |
59 | | - |
60 | | -### Basemaps |
61 | | - |
62 | | -Our nice basemaps come from all over! |
63 | | - |
64 | | -* **Light** and **Dark** basemaps: © <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, © <a href="https://cartodb.com/attributions">CARTO</a> |
65 | | -* **Black n' Gold** basemap: Map tiles from <a href="http://stamen.com">Stamen Design</a>, under <a href="http://creativecommons.org/licenses/by/3.0">CC BY 3.0</a> license. Basemap data by <a href="http://openstreetmap.org">OpenStreetMap</a>, under <a href="http://creativecommons.org/licenses/by-sa/3.0">CC BY SA</a> license. |
66 | | - |
67 | | -### Icons |
68 | | - |
| 1 | +# Pittsburgh Lenten Fish Fry Map |
| 2 | + |
| 3 | +The Pittsburgh Lenten Fish Fry Map is the brainchild of [Hollen Barmer](https://twitter.com/hollenbarmer), who has tirelessly dedicated her time since 2012 inventorying the rich array of Lenten Fish Fry events that occur every spring in Western Pennsylvania. Code for Pittsburgh helps with website development, hosting, and data maintenance! |
| 4 | + |
| 5 | +## Where Does the Fish Fry data shown on the map come from? |
| 6 | + |
| 7 | +The raw data isn't here! That is by design. The map gets data from the Fish Fry API @ [fishfry.codeforpgh.com/api/fishfries](http://fishfry.codeforpgh.com/api/fishfries). Anyone can use that URL to get data to make their own fish fry map, or do things with the Fish Fry data that we haven't thought of. If you want to learn more about the database and API, head over to the [Fish Fry Form](https://github.com/CodeForPittsburgh/fishfryform) repository. |
| 8 | + |
| 9 | +Occassional snapshots of the data from are being dumped into the `data` folder of this repo, but only for posterity. |
| 10 | + |
| 11 | +## Development |
| 12 | + |
| 13 | +This is a static web site. We're serving it up with GitHub pages, but it can run on any web server as-is, really. |
| 14 | + |
| 15 | +### Prerequisites |
| 16 | + |
| 17 | +To develop this, you have [NodeJS](https://nodejs.org/en/) installed, such that you can call `node` and `npm` from the command line. |
| 18 | + |
| 19 | +Then, in the root of this directory, run: |
| 20 | + |
| 21 | +`npm install` |
| 22 | + |
| 23 | +This will use the `package.json` file to get and install NodeJS dependencies locally, in a `node_modules` folder. |
| 24 | + |
| 25 | +You will also need these things (available on [NPM](https://www.npmjs.com)): |
| 26 | + |
| 27 | +* [GulpJS](https://www.npmjs.com/package/gulp), with `gulp` callable from the command line. Install with `npm install gulp@4.0 -g` |
| 28 | +* [Http-Server](https://www.npmjs.com/package/http-server), with `http-server` callable from the command line. Install with: `npm install http-server -g` |
| 29 | + |
| 30 | +Those two things need to be available globally. the `-g` flag in those commands makes sure of that. |
| 31 | + |
| 32 | +### Building and Watching |
| 33 | + |
| 34 | +GulpJS is a task-runner that compiles and bundles source code from `src` folder into the `assets` folder. Since the deployment path for this is GitHub pages, we put things into the `assets` folder, which is where Jekyll, the software that runs GitHub pages, expects those things to be. |
| 35 | + |
| 36 | +We run those tasks with `npm` scripts. |
| 37 | + |
| 38 | +Running `npm run build` will compile and bundle the source code one time. |
| 39 | + |
| 40 | +Running `npm run dev` will do that, plus run `http-server`, open the site in a web browser at [http://localhost:3000](http://localhost:3000), and, upon detecting changes to files in `src`, re-runs compiling/bundling and refreshes your browser. Nice! |
| 41 | + |
| 42 | +If the site doesn't load after `pnpm run dev`, check [http://localhost:4000](http://localhost:4000) in your browser. This is where `http-server` lives. If you don't see anything there, make sure you can run `http-server` from the command line (see **prerequisites** above). |
| 43 | + |
| 44 | +### Where the functionality lives / where you can hack on the code |
| 45 | + |
| 46 | +Most of the work is happening in `src/js/app.js`. The rest happens in `index.html`. |
| 47 | + |
| 48 | +> TODO: the source code for this app is a bit of a mess...the result of quick prototyping. |
| 49 | +
|
| 50 | +### Deploying this Site |
| 51 | + |
| 52 | +Run `npm run build`, commit changes, and push as-is to GitHub to deploy. |
| 53 | + |
| 54 | +## Credits |
| 55 | + |
| 56 | +The Fish Fry Map is built and maintained by members of Code for Pittsburgh. |
| 57 | + |
| 58 | +It started with <a href='https://github.com/bmcbride/bootleaf'>Bootleaf</a> (which we've adapted it and modified heavily for this project), and uses <a href="http://getbootstrap.com/">Bootstrap 3</a>, <a href="http://leafletjs.com/" target="_blank">Leaflet</a>, and <a href="http://twitter.github.io/typeahead.js/" target="_blank">typeahead.js</a>, among other things. |
| 59 | + |
| 60 | +### Basemaps |
| 61 | + |
| 62 | +Our nice basemaps come from all over! |
| 63 | + |
| 64 | +* **Light** and **Dark** basemaps: © <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors, © <a href="https://cartodb.com/attributions">CARTO</a> |
| 65 | +* **Black n' Gold** basemap: Map tiles from <a href="http://stamen.com">Stamen Design</a>, under <a href="http://creativecommons.org/licenses/by/3.0">CC BY 3.0</a> license. Basemap data by <a href="http://openstreetmap.org">OpenStreetMap</a>, under <a href="http://creativecommons.org/licenses/by-sa/3.0">CC BY SA</a> license. |
| 66 | + |
| 67 | +### Icons |
| 68 | + |
69 | 69 | Church and Warehouse icons come from © Mapbox. |
0 commit comments