https://github.com/archellir/git.station
High-performance, extremely lightweight Git service built with Zig and SvelteKit
https://github.com/archellir/git.station
ci git svelte zig
Last synced: about 2 months ago
JSON representation
High-performance, extremely lightweight Git service built with Zig and SvelteKit
- Host: GitHub
- URL: https://github.com/archellir/git.station
- Owner: archellir
- Created: 2025-03-07T04:21:16.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-07T06:16:16.000Z (over 1 year ago)
- Last Synced: 2025-03-07T07:24:09.001Z (over 1 year ago)
- Topics: ci, git, svelte, zig
- Language: Zig
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Git station
A high-performance, extremely lightweight Git service built with Zig and SvelteKit.
## Features
- Create and manage Git repositories
- Web-based repository browsing
- Branch management (create, delete)
- Pull request workflow (create, update, close, merge, delete source branch)
- CI/CD pipeline integration
- Optimized for performance and minimal resource usage
## Project Structure
```
git.station/
├── backend/ # Zig backend
├── frontend/ # SvelteKit frontend
└── scripts/ # Helper scripts
```
## Getting Started
### Prerequisites
- [Zig](https://ziglang.org/) (0.14.0 or later)
- [Node.js](https://nodejs.org/) (18 or later)
- [libgit2](https://libgit2.org/) development libraries
- [SQLite3](https://www.sqlite.org/) development libraries
### Backend Setup
```bash
cd backend
zig build
zig build run
# zig build && zig build run
```
### Frontend Setup
```bash
cd frontend
npm install
npm run dev
```
## API Reference
### Repository Management
- `GET /api/repo/{repo_name}` - Get repository details
- `GET /api/repo/{repo_name}/branches` - List branches in repository
### Branch Management
- `POST /api/repo/{repo_name}/branches` - Create a new branch
- `DELETE /api/repo/{repo_name}/branch` - Delete a branch
```json
{ "branch": "branch-name-to-delete" }
```
### Pull Request Workflow
- `GET /api/repo/{repo_name}/pulls` - List pull requests for a repository
- `GET /api/repo/{repo_name}/pulls/{id}` - Get a specific pull request
- `POST /api/repo/{repo_name}/pulls` - Create a new pull request
```json
{
"title": "Pull request title",
"body": "Description of changes",
"source_branch": "feature-branch",
"target_branch": "main"
}
```
- `PATCH /api/repo/{repo_name}/pulls/{id}` - Update a pull request
```json
{
"title": "Updated title",
"body": "Updated description",
"state": "open"
}
```
- `PUT /api/repo/{repo_name}/pulls/{id}/merge` - Merge a pull request
- `PUT /api/repo/{repo_name}/pulls/{id}/close` - Close a pull request
- `PUT /api/repo/{repo_name}/pulls/{id}/delete-branch` - Delete the source branch of a pull request
## Testing
Git Station includes a comprehensive test suite for the backend components. Tests can be run either locally or in Docker.
### Running Tests
The `run-tests.sh` script in the `backend` directory provides various options for running tests:
```bash
cd backend
sh run-tests.sh [options]
```
#### Test Options
- `--all`: Run all tests (default)
- `--git`: Run only Git-related tests
- `--db`: Run only database tests
- `--auth`: Run only authentication tests
- `--unit`: Run only unit tests
- `--local`: Run tests locally instead of in Docker
- `--help`: Show help message
### Examples
Run all tests in Docker (requires Docker and docker-compose):
```bash
sh run-tests.sh
```
Run only Git tests locally:
```bash
sh run-tests.sh --git --local
```
Run database tests locally:
```bash
sh run-tests.sh --db --local
```
### Continuous Integration
Tests are automatically run on every push to the `master` branch and on all pull requests through GitHub Actions. The workflow:
1. Builds the Docker container for testing
2. Runs the complete test suite
3. Reports the results directly in the GitHub interface
You can view test results in the "Actions" tab of the repository.
To run the same CI tests locally before pushing:
```bash
cd backend
./run-tests.sh
```
### Testing Environment Requirements
#### Local Testing
For local testing, you need:
- Zig compiler (0.14.0 or later)
- libgit2 development libraries
- SQLite3 development libraries
On macOS, you can install these with Homebrew:
```bash
brew install zig libgit2 sqlite3
```
On Linux (Debian/Ubuntu):
```bash
apt-get install zig libgit2-dev libsqlite3-dev
```
#### Docker Testing
For Docker-based testing, you need:
- Docker
- docker-compose
The Docker setup handles all dependencies automatically.
### Test Architecture
The test suite is organized into several modules:
- **Unit Tests**: Basic functionality tests for individual components
- **Git Tests**: Tests for repository creation, cloning, and management
- **Database Tests**: Tests for data persistence and retrieval
- **Authentication Tests**: Tests for user authentication and authorization
Each test module can be run independently or as part of the complete test suite.
## Development
- The backend server will be available at http://localhost:8080
- The frontend development server will be available at http://localhost:5173
## License
MIT