|
1 | | -# papermc.io [](https://discord.gg/papermc)  |
| 1 | +# HyperZoneLogin Website |
2 | 2 |
|
3 | | -The official [PaperMC](https://papermc.io) website — built with **Astro 6**, powered by **Bun**, and styled using **Tailwind CSS v4**. Content in this repository is published to [papermc.io](https://papermc.io) for viewing. |
| 3 | +The official website source for the HyperZoneLogin project. |
4 | 4 |
|
5 | | ---- |
| 5 | +This site is built with **Astro 6**, uses **Svelte** for interactive widgets, and is styled with **Tailwind CSS v4**. |
6 | 6 |
|
7 | | -## 🚀 Getting Started |
8 | | - |
9 | | -How to get the project running on your local machine for development. |
| 7 | +## Getting Started |
10 | 8 |
|
11 | 9 | ### Prerequisites |
12 | 10 |
|
13 | | -- [Node 24](https://nodejs.org) |
14 | | -- [Bun](https://bun.com/) |
| 11 | +- [Node.js](https://nodejs.org/) |
| 12 | +- [Bun](https://bun.sh/) |
15 | 13 |
|
16 | 14 | ### Local Development |
17 | 15 |
|
18 | | -1. Clone the repository. If you plan to make changes, create a fork first! |
19 | | - |
20 | | - ```bash |
21 | | - git clone --branch feat/astro https://github.com/PaperMC/website.git |
22 | | - cd website |
23 | | - ``` |
24 | | - |
25 | | -2. Install all required dependencies. |
26 | | - |
27 | | - ```bash |
28 | | - bun install |
29 | | - ``` |
30 | | - |
31 | | -3. Start the development server. |
32 | | - |
33 | | - ```bash |
34 | | - bun run dev |
35 | | - ``` |
36 | | - |
37 | | - The site will be available at: |
38 | | - 👉 http://localhost:4321 |
39 | | - |
40 | | -### Building |
41 | | - |
42 | 16 | ```bash |
43 | | -bun run build |
| 17 | +bun install |
| 18 | +bun run dev |
44 | 19 | ``` |
45 | 20 |
|
46 | | -This command builds a production-ready deployment into the `dist` directory. These files are ready to be deployed on Cloudflare Pages. |
| 21 | +By default, Astro serves the site on `http://localhost:4321`. |
47 | 22 |
|
48 | | -### Preview the production build |
| 23 | +### Production Build |
49 | 24 |
|
50 | 25 | ```bash |
| 26 | +bun run build |
51 | 27 | bun run preview |
52 | 28 | ``` |
53 | 29 |
|
54 | | -## 🧱 Project Structure |
55 | | - |
56 | | -``` |
57 | | -website/ |
58 | | -├─ src/ |
59 | | -│ ├─ pages/ # Astro route files |
60 | | -│ ├─ components/ # Astro & Svelte components (islands) |
61 | | -│ ├─ layouts/ # Shared layout templates |
62 | | -│ ├─ styles/ # Tailwind v4 theme tokens |
63 | | -│ └─ content/ # Markdown or MDX content |
64 | | -├─ public/ # Static assets (favicon, icons, etc.) |
65 | | -├─ astro.config.mjs # Astro configuration |
66 | | -├─ tailwind.config.ts |
67 | | -├─ bun.lock |
68 | | -└─ package.json |
69 | | -``` |
70 | | - |
71 | | -## 💡 Development Notes |
| 30 | +## Project Focus |
72 | 31 |
|
73 | | -This project uses Astro 6, which introduces faster rebuilds, partial hydration improvements, and first-class hybrid rendering. |
| 32 | +This website introduces HyperZoneLogin and its module ecosystem: |
74 | 33 |
|
75 | | -Svelte is used for dynamic islands and component interactivity. |
| 34 | +- proxy-layer login orchestration for Velocity |
| 35 | +- official + third-party Yggdrasil authentication |
| 36 | +- offline account support |
| 37 | +- profile and skin handling |
| 38 | +- migration tooling for legacy login plugins |
76 | 39 |
|
77 | | -Tailwind v4 leverages the new @theme token system for consistent color and typography design. |
| 40 | +## Main Directories |
78 | 41 |
|
79 | | -Bun handles dependency management and script execution, replacing Node for faster dev cycles. |
80 | | - |
81 | | -Pages are statically generated by default, with selective SSR where necessary. |
82 | | - |
83 | | -## 📚 Learn More |
84 | | - |
85 | | -🌌 [Astro 6 Documentation](https://docs.astro.build) |
86 | | - |
87 | | -🎨 [Tailwind CSS v4 Docs](https://tailwindcss.com/docs) |
88 | | - |
89 | | -⚡ [Bun Docs](https://bun.sh/docs) |
90 | | - |
91 | | -## 🛠️ Contributing |
92 | | - |
93 | | -Fork the repository and create a new branch: |
94 | | - |
95 | | -```bash |
96 | | -git checkout -b feat/my-change |
| 42 | +```text |
| 43 | +src/pages/ Route pages |
| 44 | +src/components/ Reusable UI and interactive islands |
| 45 | +src/content/ News/updates content (MDX) |
| 46 | +src/layouts/ Shared page layout |
| 47 | +public/ Static assets |
| 48 | +ref/HyperzoneLogin/ Reference project source and docs |
97 | 49 | ``` |
98 | 50 |
|
99 | | -Make your edits and run locally: |
| 51 | +## Content and Language |
100 | 52 |
|
101 | | -```bash |
102 | | -bun run dev |
103 | | -``` |
| 53 | +- Public-facing website content is written in English. |
| 54 | +- Route compatibility pages are kept for older links. |
104 | 55 |
|
105 | | -Ensure the build passes: |
| 56 | +## Contributing |
106 | 57 |
|
107 | | -```bash |
108 | | -bun run build |
109 | | -``` |
| 58 | +Open issues or pull requests on the project repositories: |
110 | 59 |
|
111 | | -Submit a pull request targeting the main branch. |
| 60 | +- https://github.com/HyperZoneLogin/HyperzoneLogin |
112 | 61 |
|
113 | 62 | ## License |
114 | 63 |
|
115 | | -The supporting code is |
116 | | -[MIT](https://github.com/PaperMC/website/blob/main/LICENSE) licensed. |
117 | | - |
118 | | -The PaperMC logomark is subject to its [own terms](https://docs.papermc.io/misc/assets) and does not |
119 | | -inherit a license from any of the projects it represents. |
| 64 | +Website code is provided under the repository license in `LICENSE`. |
0 commit comments