Welcome to nx.js + Remix!

This Remix template is configured to output a Nintendo Switch homebrew application which serves the Remix application, using nx.js. You can use nx.js APIs in your loader()/action() functions in your Remix routes.

Getting Started

Run the following command to copy this template:

npx create-remix@latest --template TooTallNate/remix-nxjs

Development

The development server mode involves running the Remix server .nro file on the Switch, while also running the "dev" script on your local machine:

1. Run the build:dev script:

   npm run build:dev

2. Create the dev mode .nro file:

   npm run nro

3. Upload the .nro file to your Switch and launch the app from the Homebrew Launcher
4. Run the dev script on your local machine, passing the URL to your Switch Remix app. This script monitors for file changes in the app directory, rebuilds the Remix app, and then uploads the new server bundle to the /__dev endpoint for the Switch to use for future HTTP requests:

   # IMPORTANT: Replace with your own Switch's IP address
   npm run dev http://192.168.86.103:8080

Generate a production .nro

First, run the build script to build your Remix app and place the client-side assets into the "romfs" directory:

npm run build

Then run the nro script to generate the final .nro file.

npm run nro

Place the .nro file onto your Switch's SD card inside the "switch" directory, and launch the app through the Homebrew Launcher (album menu). While the app is running, you can access your Remix application from a web browser using the IP address and port shown on the Switch screen.

.nro Metadata

• Add a square icon.jpg file in the root of the project to customize the icon of the NRO file
• The following package.json values are shown on the Homebrew Launcher:
  • name
  • version
  • author
• Set the titleId property in package.json to a random 16 digit hex string (example: 012a792e7a730000)
  • This allows your app to access Save Data via localStorage in loader()/action() functions