106 lines
2.2 KiB
Markdown
106 lines
2.2 KiB
Markdown
# Nexus NIIX Website
|
|
|
|
Official website for Nexus NIIX - Sovereign Technology for the Future.
|
|
|
|
## Stack
|
|
|
|
- **SvelteKit** - Static site generation
|
|
- **Alpine.JS** - Client-side interactivity
|
|
- **PicoCSS** - Lightweight CSS framework
|
|
|
|
## Development
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js >= 18.0.0
|
|
- npm or pnpm
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
git clone https://git.sovereign-society.org/nexus/nexus-niix-website.git
|
|
cd nexus-niix-website
|
|
npm install
|
|
```
|
|
|
|
### Development Server
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open http://localhost:5173 in your browser.
|
|
|
|
### Build
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
### Preview
|
|
|
|
```bash
|
|
npm run preview
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
nexus-niix-website/
|
|
├── src/
|
|
│ ├── routes/ # SvelteKit routes
|
|
│ │ ├── +layout.svelte
|
|
│ │ ├── +page.svelte
|
|
│ │ └── docs/
|
|
│ ├── lib/ # Shared components
|
|
│ └── app.html # HTML template
|
|
├── static/
|
|
│ ├── docs/ # Documentation markdown files
|
|
│ ├── pico.css # PicoCSS styles
|
|
│ └── alpine.js # Alpine.js library
|
|
├── package.json
|
|
├── svelte.config.js
|
|
├── vite.config.js
|
|
└── wrangler.toml # Cloudflare Pages config
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Documentation is written in Markdown and located in `static/docs/`.
|
|
|
|
To add a new doc:
|
|
1. Create a `.md` file in `static/docs/`
|
|
2. Add it to the navigation in `src/routes/docs/+page.svelte`
|
|
3. The page will be automatically available at `/docs/your-file-name`
|
|
|
|
## Deployment
|
|
|
|
### Cloudflare Pages (Automatic)
|
|
|
|
Push to `main` branch triggers automatic deployment to Cloudflare Pages.
|
|
|
|
Manual deployment:
|
|
```bash
|
|
npm run build
|
|
npx wrangler pages deploy .svelte-kit/output/client
|
|
```
|
|
|
|
### Manual Build
|
|
|
|
```bash
|
|
npm run build
|
|
# Output is in .svelte-kit/output/client
|
|
```
|
|
|
|
## License
|
|
|
|
This project is part of the Nexus Organization and is licensed under the **LSL-1.0** (Libertaria Source License 1.0).
|
|
|
|
See [LICENSE](https://git.sovereign-society.org/nexus/nexus/-/raw/main/LICENSE) for details.
|
|
|
|
## Links
|
|
|
|
- **Repository**: https://git.sovereign-society.org/nexus/nexus-niix-website
|
|
- **Issues**: https://git.sovereign-society.org/nexus/nexus-niix-website/-/issues
|
|
- **Organization**: https://git.sovereign-society.org/nexus
|