95 lines
1.9 KiB
Markdown
95 lines
1.9 KiB
Markdown
# Checkpoint
|
|
|
|
A minimal personal homepage built with Astro.
|
|
|
|
This project is AI-friendly and was mostly created with AI assistance, then refined as a lightweight, maintainable Astro site.
|
|
|
|
This project is a lightweight public hub for:
|
|
|
|
- a self-hosted Gitea instance
|
|
- a GitHub mirror
|
|
- gaming profiles for Steam, PlayStation, Xbox, and Nintendo Switch
|
|
|
|
It is intentionally simple: one page, reusable Astro components, minimal JavaScript, and a dark, modern design.
|
|
|
|
## Stack
|
|
|
|
- [Astro](https://docs.astro.build/)
|
|
- [Font Awesome Free](https://fontawesome.com/)
|
|
- Plain CSS
|
|
|
|
## Getting Started
|
|
|
|
Install dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Build for production:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
Preview the production build:
|
|
|
|
```bash
|
|
npm run preview
|
|
```
|
|
|
|
## Customization
|
|
|
|
Most content lives in `src/data/links.ts`.
|
|
|
|
Update this file to change:
|
|
|
|
- hero title and subtitle
|
|
- hostname/signature
|
|
- Gitea and GitHub links
|
|
- gaming profile links
|
|
|
|
## Project Structure
|
|
|
|
```text
|
|
.
|
|
├── public/
|
|
│ └── favicon.svg
|
|
├── src/
|
|
│ ├── components/
|
|
│ │ ├── Card.astro
|
|
│ │ └── Section.astro
|
|
│ ├── data/
|
|
│ │ └── links.ts
|
|
│ ├── layouts/
|
|
│ │ └── Layout.astro
|
|
│ ├── pages/
|
|
│ │ └── index.astro
|
|
│ └── styles/
|
|
│ └── global.css
|
|
├── .dockerignore
|
|
├── .gitignore
|
|
├── astro.config.mjs
|
|
├── package.json
|
|
├── README.md
|
|
└── tsconfig.json
|
|
```
|
|
|
|
## Notes
|
|
|
|
- The page is fully static and optimized for minimal client-side JavaScript.
|
|
- Icons are provided through Font Awesome brand icons.
|
|
- Styling is handled in `src/styles/global.css`.
|
|
- Content is primarily configured through `src/data/links.ts` to stay easy for both humans and AI agents to edit.
|
|
- Contributor guidance for AI/code agents lives in `AGENTS.md`.
|
|
|
|
## License
|
|
|
|
MIT
|