Complete new Design and Structure
This commit is contained in:
115
README.md
115
README.md
@@ -1,42 +1,107 @@
|
||||
# sv
|
||||
# malxte.de
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
||||
Personal about page for **Malxte** (ByteMalte) — a Rust developer, Nostr enthusiast, and content creator. Live at [malxte.de](https://malxte.de).
|
||||
|
||||
## Creating a project
|
||||
Built with [SvelteKit](https://svelte.dev/kit) and following the [BYTEMALTE Design System](./BYTEMALTE.md).
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
## Tech Stack
|
||||
|
||||
```sh
|
||||
# create a new project
|
||||
npx sv create my-app
|
||||
| Layer | Technology |
|
||||
|-------|-----------|
|
||||
| Framework | SvelteKit 2 / Svelte 5 |
|
||||
| Language | TypeScript |
|
||||
| Build Tool | Vite 7 |
|
||||
| Package Manager | pnpm |
|
||||
| Styling | Scoped CSS (component-level) |
|
||||
| Font | Inter (Google Fonts) |
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Node.js 18+
|
||||
- pnpm (enforced via `engine-strict`)
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
To recreate this project with the same configuration:
|
||||
### Development server
|
||||
|
||||
```sh
|
||||
# recreate this project
|
||||
pnpm dlx sv create --template minimal --types ts --install pnpm malxte_de
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## Developing
|
||||
Opens at [http://localhost:5173](http://localhost:5173).
|
||||
|
||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
||||
### Type checking
|
||||
|
||||
```sh
|
||||
npm run dev
|
||||
|
||||
# or start the server and open the app in a new browser tab
|
||||
npm run dev -- --open
|
||||
```bash
|
||||
pnpm check
|
||||
```
|
||||
|
||||
## Building
|
||||
### Production build
|
||||
|
||||
To create a production version of your app:
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
```bash
|
||||
pnpm build
|
||||
```
|
||||
|
||||
You can preview the production build with `npm run preview`.
|
||||
Output goes to `.svelte-kit/` (adapter-dependent for deployment).
|
||||
|
||||
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
|
||||
### Preview production build
|
||||
|
||||
```bash
|
||||
pnpm preview
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
src/
|
||||
├── app.html # HTML shell (loads Inter font)
|
||||
├── app.d.ts # SvelteKit type declarations
|
||||
├── lib/
|
||||
│ ├── index.ts # Library entry point
|
||||
│ └── assets/
|
||||
│ └── favicon.svg # Site favicon
|
||||
└── routes/
|
||||
├── +layout.svelte # Global layout (header, nav, footer)
|
||||
└── +page.svelte # Home page (hero, about, connect, projects)
|
||||
static/
|
||||
└── robots.txt # Crawl permissions
|
||||
```
|
||||
|
||||
## Sections
|
||||
|
||||
The single-page site contains four sections:
|
||||
|
||||
1. **Hero** — Name, tagline, CTA buttons, and Nostr identity card (NIP-05 + npub with copy-to-clipboard)
|
||||
2. **About Me** — Three cards covering Rust development, community building, and Nostr advocacy
|
||||
3. **Connect** — Links to ByteMalte.de, YouTube, X/Twitter, Gitea, and Reddit
|
||||
4. **Projects** — Showcases example projects (ByteMalte.de, Maltemedia)
|
||||
|
||||
## Design
|
||||
|
||||
All colors, typography, and component specs follow the [BYTEMALTE Design System v1.1](./BYTEMALTE.md). Key tokens:
|
||||
|
||||
- **Primary**: `#8888FF`
|
||||
- **Secondary**: `#3DDC84`
|
||||
- **Background**: `#0F172A`
|
||||
- **Surface**: `#1E293B`
|
||||
|
||||
All colors meet WCAG AA contrast requirements (4.5:1 minimum for normal text).
|
||||
|
||||
## Deployment
|
||||
|
||||
Uses `@sveltejs/adapter-auto` which auto-detects the deployment target. For specific platforms:
|
||||
|
||||
- **Vercel**: Works out of the box
|
||||
- **Netlify**: Works out of the box
|
||||
- **Cloudflare Pages**: Works out of the box
|
||||
- **Node.js**: Switch to `@sveltejs/adapter-node`
|
||||
|
||||
## License
|
||||
|
||||
Private — All rights reserved.
|
||||
|
||||
Reference in New Issue
Block a user