9e02eefbe0
- Add landing page and base layout with cozy theme - Configure Astro, TypeScript, and project settings - Add Dockerfile, Nginx config, and docker-compose - Include favicon and site metadata - Add documentation: README, DEVELOPMENT, PROJECT_CONTEXT, TODO, CLAUDE - Add Gitea workflows for AI chat, PR review, issue triage, and codebase review
108 lines
2.2 KiB
Markdown
108 lines
2.2 KiB
Markdown
# Cozy Den 🏡☕
|
|
|
|
A cozy landing page for hiddenden.cafe built with Astro.
|
|
|
|
## About
|
|
|
|
Cozy Den is a warm, self-hosted corner of the internet. This landing page represents the values of privacy, open-source software, and creating comfortable digital spaces.
|
|
|
|
## Features
|
|
|
|
- ☕ Cozy, warm aesthetic with hidden den theme
|
|
- 🎨 Custom color palette inspired by coffee and warmth
|
|
- 📱 Responsive design
|
|
- ⚡ Built with Astro for blazing fast performance
|
|
- 🐳 Docker support for easy deployment
|
|
|
|
## Setup
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 18+ and npm
|
|
- (Optional) Docker for containerized deployment
|
|
|
|
### Installation
|
|
|
|
1. Clone or download this project
|
|
2. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. Run the development server:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
4. Build for production:
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
5. Preview production build:
|
|
```bash
|
|
npm run preview
|
|
```
|
|
|
|
## Docker Deployment
|
|
|
|
### Building the Docker Image
|
|
|
|
```bash
|
|
docker build -t cozy-den .
|
|
```
|
|
|
|
### Running the Container
|
|
|
|
```bash
|
|
docker run -d -p 3000:3000 --name cozy-den cozy-den
|
|
```
|
|
|
|
Or with docker-compose:
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
### Pushing to Gitea Registry
|
|
|
|
```bash
|
|
# Tag the image
|
|
docker tag cozy-den git.hiddenden.cafe/mats/cozy-den:latest
|
|
|
|
# Login to your Gitea registry
|
|
docker login git.hiddenden.cafe
|
|
|
|
# Push the image
|
|
docker push git.hiddenden.cafe/mats/cozy-den:latest
|
|
```
|
|
|
|
## Customization
|
|
|
|
The site is built to be easily customizable:
|
|
|
|
- **Colors**: Edit the CSS variables in `src/layouts/BaseLayout.astro`
|
|
- **Content**: Update sections in `src/pages/index.astro`
|
|
- **Favicon**: Replace `public/favicon.svg`
|
|
|
|
## Technology Stack
|
|
|
|
- [Astro](https://astro.build/) - Static site generator
|
|
- Vanilla CSS with custom properties
|
|
- TypeScript for type safety
|
|
|
|
## Documentation
|
|
|
|
For developers and AI assistants working on this project:
|
|
- **[DEVELOPMENT.md](DEVELOPMENT.md)** - Detailed developer documentation, architecture, and common tasks
|
|
- **[PROJECT_CONTEXT.md](PROJECT_CONTEXT.md)** - Project context, design principles, and owner preferences
|
|
- **[TODO.md](TODO.md)** - Current tasks, future features, and enhancement ideas
|
|
|
|
## License
|
|
|
|
Personal project - feel free to use as inspiration for your own cozy corners of the internet!
|
|
|
|
---
|
|
|
|
Made with 💖 by Mats
|