# Borealis

**Repository Path**: xp_2133765105/borealis

## Basic Information

- **Project Name**: Borealis
- **Description**: 基于Gin + React 的个人博客项目
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-29
- **Last Updated**: 2026-08-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Borealis

A personal blog and portfolio site — built with a **Go (Gin)** backend and a **React + TypeScript** frontend.

## Project Structure

```
borealis/
├── backend/            # Go API server
│   ├── cmd/server/     # Entry point
│   ├── internal/       # Application logic (handler, service, repository, model, middleware)
│   ├── pkg/            # Shared packages (database, jwt, logger, migration, response, slug)
│   ├── migrations/     # SQL migration files
│   ├── scripts/        # Integration test scripts
│   └── data/           # Runtime data (SQLite DB, uploads, seed)
├── web/                # React SPA
│   ├── src/
│   │   ├── pages/      # Home, Article, Archive, Projects
│   │   ├── components/ # UI components
│   │   ├── layouts/    # Shell layout with sidebar, titlebar, statusbar
│   │   ├── services/   # API client & hooks
│   │   └── types/      # TypeScript type definitions
│   └── public/
├── prototype/          # HTML design prototypes
└── docs/               # Roadmap and design docs
```

## Tech Stack

| Layer       | Technology                                          |
|-------------|-----------------------------------------------------|
| Frontend    | React 19, TypeScript, Tailwind CSS, Framer Motion   |
| Backend     | Go 1.26, Gin, GORM, SQLite                         |
| Auth        | JWT (golang-jwt)                                    |
| Testing     | testify (Go), React Testing Library (frontend)      |

## Quick Start

### Backend

```bash
cd backend
cp .env.example .env   # Edit as needed
go run ./cmd/server
```

The server starts at `http://localhost:8080`.

### Frontend

```bash
cd web
npm install
npm start
```

The dev server runs at `http://localhost:3000` and proxies API requests to the backend.

## API

The backend exposes:

- **Public API** — site info, navigation, posts, projects, archive, tags, RSS
- **Admin API** — authenticated endpoints for content management (articles, projects, tags, assets, site config)

See `docs/api-contract.md` for the full contract.

## License

MIT