SirBlob
74f8c78700
Some checks failed
Build and Release / Build Windows (push) Has been cancelled
Build and Release / Build Linux (push) Has been cancelled
Build and Release / Build macOS (push) Has been cancelled
Build and Release / Create Release (push) Has been cancelled
Build and Release / Development Build (push) Has been cancelled
141 lines
3.8 KiB
Markdown
141 lines
3.8 KiB
Markdown
# Gitea Desktop
|
|
|
|
A Gitea desktop application for managing your Gitea repositories
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- **OAuth Authentication**: Secure login to your Gitea instance
|
|
- **Repository Management**: Browse and manage all your repositories
|
|
- **Quick Search**: Instantly find repositories by name, owner, or description
|
|
- **Dark Theme**: GitHub Desktop-inspired dark interface
|
|
- **Cross-platform**: Built with Tauri for native performance on Windows, macOS, and Linux
|
|
- **Fast & Lightweight**: Native performance with minimal resource usage
|
|
- **Repository Details**: View stars, forks, issues, and repository information
|
|
- **Real-time Updates**: Keep track of your repository changes
|
|
|
|
## Screenshots
|
|
|
|
<!-- Add screenshots here when available -->
|
|
|
|
## Installation
|
|
|
|
### From Releases
|
|
|
|
Download the latest version for your platform from the [releases page](https://git.sirblob.co/SirBlob/Gitea-Desktop/releases):
|
|
|
|
- **Windows**: `.msi` or `.exe` installer
|
|
- **macOS**: `.dmg` installer
|
|
- **Linux**: `.deb`, `.rpm`, or `.AppImage`
|
|
|
|
### Building from Source
|
|
|
|
**Prerequisites:**
|
|
- [Node.js](https://nodejs.org/) (v18 or higher)
|
|
- [Bun](https://bun.sh/) or npm
|
|
- [Rust](https://rustup.rs/) (for Tauri)
|
|
|
|
**Clone and build:**
|
|
```bash
|
|
git clone https://git.sirblob.co/SirBlob/Gitea-Desktop.git
|
|
cd Gitea-Desktop
|
|
|
|
# Install dependencies
|
|
bun install
|
|
|
|
# Run in development mode
|
|
bun tauri dev
|
|
|
|
# Build for production
|
|
bun tauri build
|
|
```
|
|
|
|
## Usage
|
|
|
|
### First Time Setup
|
|
|
|
1. Launch Gitea Desktop
|
|
2. Enter your Gitea server URL and personal access token
|
|
4. Start managing your repositories!
|
|
|
|
### Managing Repositories
|
|
|
|
- **Browse Repositories**: View all your repositories in the left sidebar
|
|
- **Search**: Use the search bar to quickly find repositories
|
|
- **Select Repository**: Click on any repository to view its details
|
|
- **Refresh**: Click the refresh button to update your repository list
|
|
|
|
### Creating Access Tokens
|
|
|
|
If you prefer to use a personal access token instead of OAuth:
|
|
|
|
1. Go to your Gitea instance
|
|
2. Navigate to Settings → Applications → Generate New Token
|
|
3. Give it a name and select appropriate scopes
|
|
4. Copy the token and paste it into Gitea Desktop
|
|
|
|
## Configuration
|
|
|
|
Gitea Desktop stores your authentication securely using the system's credential manager. Your credentials are never stored in plain text.
|
|
|
|
## Technology Stack
|
|
|
|
- **Frontend**: SvelteKit 5 with Svelte Runes
|
|
- **Backend**: Tauri (Rust)
|
|
- **Styling**: Tailwind CSS, Skeleton UI
|
|
- **Icons**: Iconify
|
|
|
|
## Development
|
|
|
|
### Available Scripts
|
|
|
|
```bash
|
|
# Development
|
|
bun tauri dev # Run in development mode
|
|
|
|
# Building
|
|
bun tauri build # Build for production
|
|
|
|
# Frontend only
|
|
bun run dev # Run SvelteKit dev server
|
|
bun run build # Build frontend
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
|
|
1. Fork the repository
|
|
2. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
|
3. Open a Pull Request
|
|
|
|
## Roadmap
|
|
|
|
- [ ] Clone repositories directly from the app
|
|
- [ ] Create new repositories
|
|
- [ ] View commit history
|
|
- [ ] Manage branches
|
|
- [ ] Pull request management
|
|
- [ ] Issue tracking
|
|
- [ ] File browser
|
|
- [ ] Diff viewer
|
|
- [ ] Git operations (commit, push, pull)
|
|
- [ ] Multiple account support
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
|
|
## Acknowledgments
|
|
|
|
- Inspired by [GitHub Desktop](https://desktop.github.com/)
|
|
- Built with [Tauri](https://tauri.app/)
|
|
- UI components from [Skeleton UI](https://skeleton.dev/)
|
|
|
|
## Support
|
|
|
|
If you encounter any issues or have questions:
|
|
- [Report a bug](https://git.sirblob.co/SirBlob/Gitea-Desktop/issues)
|
|
- [Request a feature](https://git.sirblob.co/SirBlob/Gitea-Desktop/issues)
|
|
- Check the [documentation](https://git.sirblob.co/SirBlob/Gitea-Desktop/wiki) (coming soon) |