nexus
/
nexus-niix-website
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
nexus-niix-website/README.md

2.2 KiB
Raw Blame History

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

git clone https://git.sovereign-society.org/nexus/nexus-niix-website.git
cd nexus-niix-website
npm install

Development Server

npm run dev

Open http://localhost:5173 in your browser.

Build

npm run build

Preview

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:

npm run build
npx wrangler pages deploy .svelte-kit/output/client

Manual Build

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 for details.

Links