62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
# STARSET Mirror Project Homepage
|
|
|
|
Visit: [https://mirror.starset.fans](https://mirror.starset.fans)
|
|
|
|
## Environment Requirements
|
|
|
|
- Node.js (recommended v18+)
|
|
- pnpm (pnpm is recommended as the package manager)
|
|
|
|
## Quick Start
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://git.owu.one/starset-mirror/homepage
|
|
cd homepage
|
|
```
|
|
|
|
2. Install dependencies:
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
3. Start the development server:
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
4. Build for production:
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
homepage
|
|
├── data/ # Content files
|
|
│ ├── zh-CN/ # Simplified Chinese data
|
|
│ ├── zh-TW/ # Traditional Chinese data
|
|
│ └── en-US/ # English data
|
|
├── src/ # Source code
|
|
├── public/ # Static assets
|
|
├── docs/ # Documentation
|
|
└── scripts/ # Build and tool scripts
|
|
```
|
|
|
|
## Contribution Guide
|
|
|
|
See [CONTRIBUTING.md](docs/en-US/CONTRIBUTING.md) in the `docs` directory to learn how to participate in the project.
|
|
|
|
## License
|
|
|
|
All content and documentation of this project (`/data` and `/docs`) are under the CC BY-NC-SA 4.0 license.
|
|
|
|
The source code of this project is under the AGPL 3.0 license.
|
|
|
|
## Contact Us
|
|
|
|
If you have any questions or suggestions, feel free to contact us via:
|
|
|
|
- Submitting an Issue
|
|
- [https://mirror.starset.fans/about](https://mirror.starset.fans/about)
|