You've already forked switch-guide
mirror of
https://github.com/nh-server/switch-guide.git
synced 2026-04-30 11:24:21 -07:00
grunt22fox
ef1ca867e9
* Substantial Markdown overhaul * Update README and LICENSE, as well as copyright * Reword instructions regarding copying folders in sd_preparation.md * Add archive bit warning to transfer_sd.md * Ensure consistency, remove more unneeded <br> * Remove more unneeded HTML * Reorganization of index page for readability * Add boldness to brick risk words * Slight rewording on index.md * Fix an incorrectly formatted number list * Remove a redundant image * Change SD to microSD, adjust tab defaults
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# Switch Hacks Guide
|
|
|
|
A collaboration from Nintendo Homebrew's Discord community, getting you from a stock Switch to Atmosphère.
|
|
|
|
[](https://switch.hacks.guide/)
|
|
[](https://discord.gg/C29hYvh)
|
|
[](https://github.com/nh-server/switch-guide/commits/master/)
|
|
[](https://github.com/nh-server/switch-guide/blob/master/LICENSE.md)
|
|
|
|
## Running the site locally
|
|
|
|
This requires the following installed on your system:
|
|
|
|
* [node.js](https://nodejs.org/en)
|
|
|
|
To test the website locally, clone the source code:
|
|
|
|
```shell
|
|
git clone https://github.com/nh-server/switch-guide.git --recurse-submodules
|
|
cd switch-guide
|
|
```
|
|
|
|
Then simply run the following commands:
|
|
|
|
```shell
|
|
npm ci
|
|
npm run docs:dev
|
|
```
|
|
|
|
> [!TIP]
|
|
> If you choose to run multiple web servers at once, they will begin running at the next highest usable port (e.g. :5174, :5175, and so on).
|
|
|
|
The website should now be running on <http://127.0.0.1:5173/> (or whatever port is shown on the terminal).
|