Files
Cozy-Den/README.md
T
Latte e27d00ad86 remove internal documentation before making repo public
Deleted: AGENTS.md, CLAUDE.md, CODE_OF_CONDUCT.md, DEVELOPMENT.md,
FUTURE_PLANS.md, PROJECT_CONTEXT.md, SECURITY.md, TODO.md,
public/FAVICON_INSTRUCTIONS.md

These were internal planning docs, AI tool context files, and outdated
roadmap/todo files with no value for public visitors. README updated to
remove references to deleted files.
2026-03-26 19:57:16 +01:00

104 lines
2.1 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
- 🎨 Catppuccin Mocha color palette
- 📱 Responsive design
- ⚡ Built with Astro for blazing fast performance
- 🐳 Docker support for easy deployment
- 📝 Blog powered by Astro Content Collections (hardcoded Markdown, no CMS)
## 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:80 --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`
- **Blog posts**: Add `.md` files to `src/content/blog/` — they appear automatically at `/blog`
- **Blog images**: Place images in `public/blog/<post-slug>/` and reference with `/blog/<post-slug>/image.jpg`
## Technology Stack
- [Astro](https://astro.build/) - Static site generator
- Vanilla CSS with custom properties
- TypeScript for type safety
## License
Personal project - feel free to use as inspiration for your own cozy corners of the internet!
---
Made with 💖 by Latte