mirror of
https://iceshrimp.dev/Crimekillz/jointrashposs.git
synced 2024-11-25 02:09:05 +01:00
94 lines
1.8 KiB
Markdown
94 lines
1.8 KiB
Markdown
# Join TrashPoss Web Template (Next)
|
|
|
|
Website Template for Join TrashPoss, built with [Nuxt](https://nuxt.com/).
|
|
|
|
Live at [jointrashposs.org](jointrashposs.org)
|
|
|
|
## Changing the Title of Blog Posts (Notices)
|
|
|
|
Refer to `app.config.ts`
|
|
|
|
## Docs
|
|
|
|
**Make sure to read [`/content/.README.md`](./content/.README.md)**
|
|
|
|
## Infos about the use of NuxtLink
|
|
|
|
Enhanced processing regarding internal and external links [`<GNuxtLink>`](. /components/g/NuxtLink.vue), please use `<GNuxtLink>` instead of `<NuxtLink>` when adding **links. **
|
|
|
|
We also use the `useGLocalePath` composable function that wraps the `useLocalePath` used to create dynamic links in order to apply the appropriate settings for the hosting environment to Nuxt's routing solution.
|
|
|
|
### Links to Join TrashPoss within templates
|
|
|
|
In GNuxtLink and various Docs, if you start with `x-trash-web://` in the address, followed by the relative path to Misskey, it will be replaced by a link to Join TrashPoss.
|
|
|
|
For example, instead of using `/play` → `x-trash-web://play`
|
|
|
|
## Setup
|
|
|
|
Make sure to install the dependencies:
|
|
|
|
```bash
|
|
# npm
|
|
npm install
|
|
|
|
# pnpm
|
|
pnpm install
|
|
|
|
# yarn
|
|
yarn install
|
|
```
|
|
|
|
## Development Server
|
|
|
|
Start the development server on `http://localhost:3000`:
|
|
|
|
```bash
|
|
# npm
|
|
npm run dev
|
|
|
|
# pnpm
|
|
pnpm run dev
|
|
|
|
# yarn
|
|
yarn dev
|
|
```
|
|
|
|
## Production
|
|
|
|
Build the application for production:
|
|
|
|
```bash
|
|
# npm
|
|
npm run build
|
|
|
|
# pnpm
|
|
pnpm run build
|
|
|
|
# yarn
|
|
yarn build
|
|
```
|
|
|
|
Locally preview production build:
|
|
|
|
```bash
|
|
# npm
|
|
npm run preview
|
|
|
|
# pnpm
|
|
pnpm run preview
|
|
|
|
# yarn
|
|
yarn preview
|
|
```
|
|
|
|
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|
|
|
|
## License and Attribution
|
|
|
|
This template is a fork of the Misskey-Hub Web Template
|
|
|
|
GNU Affero General Public License v3.0
|
|
|
|
(c) 2023-2024 syuilo, kakkokari-gtyih and Misskey Project
|
|
(c) 2024 Crimekillz and TrashPoss Project |