From 855baef28e1ceb5db0eb36b027dd9409ff8aed58 Mon Sep 17 00:00:00 2001 From: kitten Date: Sat, 18 Jul 2026 21:59:04 +0200 Subject: [PATCH] update readme --- README.md | 63 ++++++++++++++++++++++++------------------------------- 1 file changed, 27 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index b6de9b9..e84c182 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,37 @@ -# Astro Starter Kit: Basics +# eShop Frontend Server +> [!NOTE] +> This server requires a Ninja API server, the samurai server and a NNAS server that supports generating service tokens and polling information from generated tokens. Running your own eShop is no easy task! Please only attempt to do this if you are well versed in how the Wii U works. -```sh -bun create astro@latest -- --template basics +## Overview +The eShop runs using a static website, albeit with parts of generated JS. This repository takes a dump of the eShop and applies patches for you to be able to run your own eShop! + +### Running Dev server +To get started, first install Bun. Now run: + +```bash +bun install ``` -> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +Before you run the server, you must configure the ninja & samurai URLs. a build config at `./build-config.json.example` is provided for your convenience(and ours.) First rename it to just `build-config.json`, and fill in the slots. -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: - -```text -/ -├── public/ -│ └── favicon.svg -├── src -│   ├── assets -│   │   └── astro.svg -│   ├── components -│   │   └── Welcome.astro -│   ├── layouts -│   │   └── Layout.astro -│   └── pages -│   └── index.astro -└── package.json +```json +{ + "https://ninja.wup.shop.nintendo.net/ninja/": "ur ninja server", + "https://samurai.wup.shop.nintendo.net/samurai/": "ur samurai server " +} ``` -To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). +If you do not wish to run your own server and only check out thr eShop in this form, you may put the same urls twice. +> [!WARNING] +> Using the same URLs will not work on a console, and due to CORs you may run into issues when viewing the website on a computer. This is only recommended for research, and should **NEVER** be deployed to production. Do this at your own risk! -## 🧞 Commands +Once you have filled in the URLs, you may now run: -All commands are run from the root of the project, from a terminal: +```bash +bun run dev +``` -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `bun install` | Installs dependencies | -| `bun dev` | Starts local dev server at `localhost:4321` | -| `bun build` | Build your production site to `./dist/` | -| `bun preview` | Preview your build locally, before deploying | -| `bun astro ...` | Run CLI commands like `astro add`, `astro check` | -| `bun astro -- --help` | Get help using the Astro CLI | +Now you got your very own eShop frontend! Congratulations! -## 👀 Want to learn more? - -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). +## Notice of Copyright +Most content in this repository is modified code produced by Nintendo co ltd. We are not responsible for any action taken on you because of this fact. The purpose of this repository is to preserve the eShop and its frontend. We are not affiliated with Nintendo in any way. \ No newline at end of file