📝 Update README.md

This commit is contained in:
2025-12-25 23:45:05 +08:00
parent 5f49c67874
commit 4cf7035953

View File

@@ -1,75 +1,9 @@
# Nuxt Minimal Starter
# Floating Island
Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
Floating Island is the detached web version of frontend for the Solar Network.
## Setup
It is required to have in an Solar Network, since it provide some core
functionality such as the captcha.
Make sure to install dependencies:
```bash
# npm
npm install
# pnpm
pnpm install
# yarn
yarn install
# bun
bun install
```
## Development Server
Start the development server on `http://localhost:3000`:
```bash
# npm
npm run dev
# pnpm
pnpm dev
# yarn
yarn dev
# bun
bun run dev
```
## Production
Build the application for production:
```bash
# npm
npm run build
# pnpm
pnpm build
# yarn
yarn build
# bun
bun run build
```
Locally preview production build:
```bash
# npm
npm run preview
# pnpm
pnpm preview
# yarn
yarn preview
# bun
bun run preview
```
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
The project is built with Nuxt v4 with SSR enabled.
It is recommended to use docker and bun to run this project.