Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpchip/mke-frozen-treats
Flavors of the Day at Milwaukee area Frozen Custard Stands
https://github.com/jpchip/mke-frozen-treats
custard deno milwaukee mke puppeteer pwa
Last synced: 18 days ago
JSON representation
Flavors of the Day at Milwaukee area Frozen Custard Stands
- Host: GitHub
- URL: https://github.com/jpchip/mke-frozen-treats
- Owner: jpchip
- License: mit
- Created: 2023-08-14T03:29:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-17T13:41:37.000Z (9 months ago)
- Last Synced: 2024-04-17T14:52:05.390Z (9 months ago)
- Topics: custard, deno, milwaukee, mke, puppeteer, pwa
- Language: TypeScript
- Homepage: https://mkefrozentreats.com/
- Size: 141 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MKE Frozen Treats 🍦
> Flavor of the Day Tracker
This application lists the flavor of the day at Frozen Custard vendors around the MKE area.
## Installing / Getting started
Consists of two pieces, the importer script and the site. See the readme in each directory for more details on each.
The gist though is this:
1. run the importer to pull in the flavor of the day from all the sites defined in `sites.json` (or you can point to another file).
```shell
deno run -A --unstable importer.ts --sites ./sites.json
```
2. Launch the server to view the outputted flavors in a website:
```shell
deno run --allow-env --allow-net --allow-read server.ts
```
## Developing
### Built With
- [Deno](https://deno.com/)
- [Puppeteer](https://pptr.dev/)
- [Alpine.js](https://alpinejs.dev/)
- [Bootstrap](https://getbootstrap.com/)
- [Axios](https://axios-http.com/)
- [ETA](https://eta.js.org/)
### Prerequisites
- Deno >=1.36.1
### Setting up Dev
Install Chrome for Puppeteer:
```shell
deno run -A --unstable https://deno.land/x/[email protected]/install.ts
```
Copy `importer/.env.example` to `.env`. You don't need to touch it beyond that unless you want to make use of browserless.io for scraping and R2 for storing the file.
Copy `site/.env.example` to `.env`. You don't need to touch it beyond that unless you have a custom url to your list of flavors of the day.
### Building
Right now the `index.html` is hard coded to my flavorOfTheDay.json file on R2. To use a local copy or your own, replace the url as needed.
### Deploying / Publishing
The importer needs a cronjob or some other timer to generate a new file daily.
The website can run anywhere, it just needs to point to the json file generated by the importer.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [link to tags on this repository](/tags).
## Configuration
### Importing Frozen Custard Sites
The site the Importer pulls from are defined in the `sites.json`. Each site needs a corresponding script file that returns the flavor of the day. These scripts file should export a `load` function in the format of:
```
type LoadFunction = (browser: Browser, site: MkeFrozenTreatsImporter.Site) => string;
```
By default the importer loads up the site.json located in the importer directory. It outputs to `/sites/output.json` by default, but you can set a custom destination with the `--output` flag.
## Tests
```
deno test --allow-read
```
## Style guide
Uses Deno lint in VS Code, and Deno FMT for automatic code formatting.
## Forking
This could easily be forked and setup for your own locations! You could even swap out custard with some other thing (eg. soup, tacos, sales). Have fun with it!
## Limitations
Some sites (*cough* Bubba's *cough*) use hosting that block Bots like Puppeteer, so they cannot be scraped consistently.
Other places only list their flavors of the day on their facebook page and use inconsistent formatting that can't be scrapped.
## Licensing
See LICENSE file