README.md
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
90
README.md
Normal file
90
README.md
Normal file
@@ -0,0 +1,90 @@
|
||||
# Checkpoint
|
||||
|
||||
A minimal personal homepage built with Astro.
|
||||
|
||||
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`.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user