docs: update .gitignore and README
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
10
.gitignore
vendored
10
.gitignore
vendored
@@ -1,6 +1,12 @@
|
|||||||
bin/
|
bin/
|
||||||
|
data/
|
||||||
|
*.db
|
||||||
|
*.db-shm
|
||||||
|
*.db-wal
|
||||||
|
web/node_modules/
|
||||||
|
web/dist/
|
||||||
*.exe
|
*.exe
|
||||||
*.test
|
*.test
|
||||||
*.out
|
*.out
|
||||||
web/dist/
|
.idea/
|
||||||
web/node_modules/
|
.vscode/
|
||||||
|
|||||||
31
README.md
31
README.md
@@ -4,7 +4,7 @@ Cross-platform tool to synchronize all repositories from multiple Gitea servers
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Single binary deployment
|
- Single binary deployment (frontend embedded)
|
||||||
- Web UI for management (Vue 3 + Element Plus)
|
- Web UI for management (Vue 3 + Element Plus)
|
||||||
- SQLite database
|
- SQLite database
|
||||||
- JWT authentication
|
- JWT authentication
|
||||||
@@ -14,20 +14,47 @@ Cross-platform tool to synchronize all repositories from multiple Gitea servers
|
|||||||
## Build
|
## Build
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make all
|
# Build binary with embedded frontend
|
||||||
|
go build -o bin/gitm .
|
||||||
|
|
||||||
|
# Or with CGO for SQLite support
|
||||||
|
CGO_ENABLED=1 go build -o bin/gitm .
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run
|
## Run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# First-time initialization (set admin password)
|
||||||
./bin/gitm --init
|
./bin/gitm --init
|
||||||
|
|
||||||
|
# Start server (default :9000)
|
||||||
./bin/gitm
|
./bin/gitm
|
||||||
|
|
||||||
|
# Custom address
|
||||||
./bin/gitm --addr :9090
|
./bin/gitm --addr :9090
|
||||||
|
|
||||||
|
# Custom data directory
|
||||||
|
./bin/gitm --data /path/to/data
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
1. Initialize: `./bin/gitm --init` -- sets admin password
|
||||||
|
2. Start: `./bin/gitm` -- starts web server
|
||||||
|
3. Open browser to `http://localhost:9000`
|
||||||
|
4. Login and add Gitea servers
|
||||||
|
5. Discover repos and sync
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Frontend dev server
|
||||||
cd web && npm install && npm run dev
|
cd web && npm install && npm run dev
|
||||||
|
|
||||||
|
# Backend
|
||||||
go run main.go
|
go run main.go
|
||||||
|
|
||||||
|
# Run tests
|
||||||
|
go test ./internal/gitea/... -v
|
||||||
|
CGO_ENABLED=1 go test ./internal/database/... -v
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user