From 5951d7e4a4cd8b52e1a9cf03b84f65db88b033b9 Mon Sep 17 00:00:00 2001 From: Matt Isenhower Date: Thu, 14 Nov 2024 21:48:34 -0800 Subject: [PATCH] Update readme --- readme.md | 30 ++++++++++-------------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/readme.md b/readme.md index 2c8c988..5e21a0c 100644 --- a/readme.md +++ b/readme.md @@ -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 ```