Leahnaya/splatoon2.ink
1
0
Fork 0
mirror of https://github.com/misenhower/splatoon2.ink.git synced 2026-08-22 02:14:21 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Matt Isenhower
2024-11-14 21:48:34 -08:00
parent 004d47863c
commit 5951d7e4a4
1 changed files with 10 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
readme.md
View File

@@ -1,5 +1,8 @@
# [Splatoon2.ink](https://splatoon2.ink)
> [!NOTE]
> Check out [Splatoon3.ink](https://github.com/misenhower/splatoon3.ink) as well!
Splatoon2.ink shows the current and upcoming map schedules for Splatoon 2.
This site was built with [Vue.js](https://vuejs.org/) and [Bulma](http://bulma.io/).
@@ -7,8 +10,6 @@ All data comes from the SplatNet 2 API.
More information about Nintendo's API can be found [here](https://github.com/ZekeSnider/NintendoSwitchRESTAPI).
**Note:** The Splatnet updater script requires Node.js v8 or later.
## Getting Started
Clone this repo:
@@ -26,38 +27,27 @@ cp .env.example .env
You can retrieve your `iksm_session` ID value (`NINTENDO_SESSION_ID` inside `.env`) using [Fiddler](http://www.telerik.com/fiddler) or a similar tool.
See [here](https://github.com/frozenpandaman/splatnet2statink#setup-instructions) for further instructions.
I recommend using [Yarn](https://yarnpkg.com/en/) to manage JS dependencies.
```shell
yarn install # Install dependencies
yarn splatnet # Retrieve updates from Splatnet and the Salmon Run calendar
yarn serve # Start the webpack dev server
npm install # Install dependencies
npm run splatnet # Retrieve updates from Splatnet and the Salmon Run calendar
npm run serve # Start the webpack dev server
```
Data retrieved from Splatnet is stored in the `public/data` directory.
Data retrieved from Splatnet is stored in the `dist/data` directory.
By default, the dev server will run on port 8080.
When running `yarn serve` you can access the site by going to http://localhost:8080.
When running `npm run serve` you can access the site by going to http://localhost:8080.
## Production
Build minified assets for production:
```shell
yarn build
npm run build
```
Retrieve updates from Splatnet every hour via [node-cron](https://github.com/kelektiv/node-cron):
```shell
yarn cron
```
## Docker
I use a Docker container on my production server to build production assets and retrieve data from Splatnet.
```shell
sudo docker-compose run --rm app yarn build # Build production assets
sudo docker-compose up -d app # Start periodic updates
npm run cron
```