Marown/heissepreise
1
0
Fork 0
mirror of https://github.com/badlogic/heissepreise.git synced 2024-06-20 15:35:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mario Zechner 2023-06-19 17:45:08 +02:00
parent 9f4d06467f
commit 35c4117689
1 changed files with 19 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -29,6 +29,7 @@ Install NodeJS, then run this in a shell of your choice.
```bash
git clone https://github.com/badlogic/heissepreise
cd heissepreise
mkdir -p data
npm install
npm run dev
```
@ -56,60 +57,19 @@ Subsequent starts will fetch the data asynchronously, so you can start working i
Install the dependencies as per above, then simply run:
```
npm run start
git clone https://github.com/badlogic/heissepreise
cd heissepreise
npm install
npm run dev
```
### Frontend
Once the app is listening per default on port 3000, open <http://localhost:3000> in your browser.
To build the `site/style.css` file, make sure to run `npm run build`. This will create a css file based on the tailwind styles used. You can continue to write normal CSS in the `site/tailwind.css` if you want.
### Configuration
You can pass the following options to the `server.js` script:
- `-p`, `--port`: the port to listen on, defaults to the `PORT` environment variable, if set, or `3000`
- `-l`, `--live-reload`: whether to enable live reload, defaults to `true` when `NODE_ENV` is `development`. Cannot be used in production.
### Via GitHub pages & GitHub workflows
Create a GitHub account and pick a username. Below, we assume your user name is `hotprices123`. **Replace `hotprices123` with your real username everywhere you see it below**
1. Log in to your GitHub account.
2. [Fork](https://github.com/badlogic/heissepreise/fork) this repository and name the repository `hotprices123.github.io`.
3. **In your forked repository**:
1. go to `Settings > Pages`, then under `Branch` select the `main` branch, and the `docs/` directory as shown in this screenshot.
![site/img/github-pages.png](site/img/github-pages.png)
2. go to `Settings > Actions > General`, then under `Workflow permissions`, select `Read and write permissions` as shown in this screenshot.
![site/img/github-permissions.png](site/img/github-permissions.png)
3. go to the `Actions` tab, then select the `Pages Update` workflow in the list to the left, then click `Enable workflow`. Confirm that you know what you are doing.
![site/img/github-workflow.png](site/img/github-workflow.png)
4. Trigger the workflow once manually to build the initial site and data.
![site/img/github-workflow2.png](site/img/github-workflow2.png)
5. Once the workflow has finished, go to `https:/hotprices123.github.io` and enjoy your price comparisons.
The data will be automatically fetched once a day at 8am (no idea what timezone), and the site will be updated.
To get the latest code changes from this repository into your fork:
1. Go to `https://github.com/hotprices123/hotprices123.github.io/compare/main...badlogic:heissepreise:main`
2. Click on `Create pull request`
![site/img/github-pullrequest.png](site/img/github-pullrequest.png)
3. Enter a Title like "Updated from upstream", then click `Create pull request``
![site/img/github-pullrequest2.png](site/img/github-pullrequest2.png)
4. Click `Merge pull request`
![site/img/github-pullrequest3.png](site/img/github-pullrequest3.png)
Your site will now use the latest source code changes from this repository. It will be automatically updated and is usually live under `https://hotprices123.github.io` within 10-15 minutes.
### Docker
The project has a somewhat peculiar Docker Compose setup in `docker/` tailored to my infrastructure. You can entirely ignore it.
## Raw Data
## Using data from heisse-preise.io
You can also get the [raw data](https://heisse-preise.io/data/latest-canonical.json). The raw data is returned as a JSON array of items. An item has the following fields:
- `store`: (`billa`, `spar`, `hofer`, `dm`, `lidl`, `mpreis`)
- `store`: (`billa`, `spar`, `hofer`, `dm`, `lidl`, `mpreis`, ...)
- `name`: the product name.
- `price`: the current price in €.
- `priceHistory`: an array of `{ date: "yyyy-mm-dd", price: number }` objects, sorted in descending order of date.
@ -117,7 +77,17 @@ You can also get the [raw data](https://heisse-preise.io/data/latest-canonical.j
- `quantity`: quantity the product is sold at for the given price
- `bio`: whether this product is classified as organic/"Bio"
## Historical Data
If you run the project locally, you can use the data from the live site including the historical data as follows:
```
cd heisse-preise
rm data/latest-canonical.*
curl -O data/latest-canonical.json https://heisse-preise.io/data/latest-canonical.json
```
Restart the server with either `npm run dev` or `npm run start`.
## Historical Data Credits
The live site at [heisse-preise.io](https://heisse-preise.io) feature historical data from: