https://github.com/rickdgray/nintendostockchecker
https://github.com/rickdgray/nintendostockchecker
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/rickdgray/nintendostockchecker
- Owner: rickdgray
- License: gpl-3.0
- Created: 2024-05-24T04:22:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T00:42:52.000Z (almost 2 years ago)
- Last Synced: 2025-03-15T07:47:16.738Z (over 1 year ago)
- Language: C#
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nintendo Stock Checker
Get push notifications right to your phone when Nintendo merch is back in stock!
## Pushover
You will need an account at [Pushover](https://pushover.net/) to be able to run this. Be sure to also create an application and get the associated `API Token/Key` as well.
## Settings
Once you create an account and have both a `User Key` and an `API Token/Key`, you need to pass them in at runtime. The settings are:
* PushoverUserKey
* PushoverAppKey
* PollRateInSeconds (optional, defaults to 5)
## Deploying
Simply run with the necessary environment variables set and the image specified.
```bash
docker run -itd --restart unless-stopped \
--env Settings__PushoverUserKey='abcd1234' \
--env Settings__PushoverAppKey='abcd1234' \
ghcr.io/rickdgray/nintendostockchecker:main
```
## Updating
First kill any currently running containers. Then update your local docker image with the following command.
```bash
docker pull ghcr.io/rickdgray/nintendostockchecker:main
```
Then you can run the deployment command above to start anew.
## Building
Projects in .NET have an unusual folder structure, so when building we must both specify the context to be at the root of the solution, but also specify the location of the `dockerfile`.
```bash
docker build -f .\NintendoStockChecker\Dockerfile .
```
## Debugging
You can edit the `launchSettings.json` file with your secrets. Then set the startup dropdown to "Docker" so that Visual Studio will create a container. This will allow you to debug with a local container.
```json
{
"profiles": {
"Docker": {
"commandName": "Docker",
"environmentVariables": {
"Settings__PushoverUserKey": "abcd1234",
"Settings__PushoverAppKey": "abcd1234"
}
}
}
}
```