jointrashposs/README.md

94 lines
1.8 KiB
Markdown
Raw Normal View History

2024-04-08 10:03:26 +02:00
# Join TrashPoss Web Template (Next)
2023-07-08 10:36:02 +02:00
2024-04-08 10:03:26 +02:00
Website Template for Join TrashPoss, built with [Nuxt](https://nuxt.com/).
2023-07-08 10:36:02 +02:00
2024-04-08 10:03:26 +02:00
Live at [jointrashposs.org](jointrashposs.org)
2023-07-08 10:36:02 +02:00
2024-04-08 10:03:26 +02:00
## Changing the Title of Blog Posts (Notices)
2023-09-24 12:43:14 +02:00
2024-04-08 10:03:26 +02:00
Refer to `app.config.ts`
2023-11-11 13:03:15 +01:00
2024-04-08 10:03:26 +02:00
## Docs
2023-11-11 13:03:15 +01:00
2024-04-08 10:03:26 +02:00
**Make sure to read [`/content/.README.md`](./content/.README.md)**
2023-09-24 12:43:14 +02:00
2024-04-08 10:03:55 +02:00
## Infos about the use of NuxtLink
2024-04-08 10:03:26 +02:00
Enhanced processing regarding internal and external links [`<GNuxtLink>`](. /components/g/NuxtLink.vue), please use `<GNuxtLink>` instead of `<NuxtLink>` when adding **links. **
2024-04-08 10:03:26 +02:00
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.
2024-04-08 10:03:26 +02:00
### Links to Join TrashPoss within templates
2024-04-08 10:03:26 +02:00
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.
2024-04-08 10:03:26 +02:00
For example, instead of using `/play``x-trash-web://play`
2023-07-08 10:36:02 +02:00
## 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.
2023-11-11 13:03:15 +01:00
2024-04-08 10:03:26 +02:00
## License and Attribution
2023-12-21 11:32:32 +01:00
2024-04-08 10:03:26 +02:00
This template is a fork of the Misskey-Hub Web Template
2023-11-11 13:03:15 +01:00
GNU Affero General Public License v3.0
2024-02-12 04:36:35 +01:00
(c) 2023-2024 syuilo, kakkokari-gtyih and Misskey Project
2024-04-08 10:03:26 +02:00
(c) 2024 Crimekillz and TrashPoss Project