Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/starfish-app/Starfish

A Gemini browser for elementary OS.
https://github.com/starfish-app/Starfish

elementary-os gemini gemini-client gtk gtk3 meson vala

Last synced: 8 days ago
JSON representation

A Gemini browser for elementary OS.

Host: GitHub
URL: https://github.com/starfish-app/Starfish
Owner: starfish-app
License: gpl-3.0
Created: 2021-06-08T23:16:23.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-07-31T18:50:38.000Z (over 2 years ago)
Last Synced: 2024-08-02T00:26:09.160Z (3 months ago)
Topics: elementary-os, gemini, gemini-client, gtk, gtk3, meson, vala
Language: Vala
Homepage: gemini://josipantolis.from.hr/starfish/
Size: 4.27 MB
Stars: 22
Watchers: 1
Forks: 1
Open Issues: 17
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

awesome-vala - Starfish - A Gemini browser for elementary OS. (Apps / Internet Browsers)

README

Starfish

A [Gemini](https://gemini.circumlunar.space/) browser made for [elementary OS](https://elementary.io/).

[![Get it on AppCenter](https://appcenter.elementary.io/badge.svg)](https://appcenter.elementary.io/hr.from.josipantolis.starfish)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](COPYING)
[![Build](https://github.com/starfish-app/Starfish/actions/workflows/main.yml/badge.svg)](https://github.com/starfish-app/Starfish/actions)
[![GitHub release](https://img.shields.io/github/v/release/starfish-app/Starfish)](https://github.com/starfish-app/Starfish/releases)

|![Gemini pages are displayed with your chosen accent color and light or dark style](data/screenshots/styling.png)|![gentle introduction to Gemini is provided to help you find your bearings](data/screenshots/intro-to-gemini.png)|
|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
|![page search and table of contents help you navigate larger gemtext pages](data/screenshots/search-and-toc.png)|![connection to Gemini sites is secured by both server and client certificates](data/screenshots/certificates.png)|

For more screenshots check out the [screenshots directory](data/screenshots).

## About

Starfish is a graphical client for the Gemini protocol built with GTK and Vala. The main goal of the project is to provide a native elementary OS application for reading Gemini sites, that will make the protocol more accessible to users. Read more on the project's Gemini page: [gemini://josipantolis.from.hr/starfish/](gemini://josipantolis.from.hr/starfish/).

### Status

Starfish is in active development. It currently supports the prerelease version of the Gemini specification, including gemtext rendering and client certificates. Starfish can be used to view images and download other file types. There are still many improvements and new features that could be added to the app. For a list of current development plans check out [GitHub issues](https://github.com/starfish-app/Starfish/issues).

## Install

Starfish is packaged with [Flatpak](https://www.flatpak.org/) and published on elementary OS AppCenter. If you are running some other Linux distribution you can download the `flatpakref` file from [elementary repo](https://flatpak.elementary.io/repo/appstream/hr.from.josipantolis.starfish.flatpakref) and install it either using a graphical package manager, or from terminal with:

```sh
flatpak install --from ./hr.from.josipantolis.starfish.flatpakref
```

## Build from source

Starfish is built for elementary OS 6. All prerequisites can be met by installing `elementary-sdk` and `gtkspell`:

```sh
sudo apt install elementary-sdk
sudo apt install libgtkspell3-3-dev
```

For a full list of dependencies check out the `dependencies` list in the [meson.build file](meson.build#L11-L20).

To build and install the app execute (from project's root directory):

```sh
meson build --prefix=/usr
cd build
ninja
sudo ninja install
```

### Test

After performing meson build you can run tests from inside `build` directory with:

```sh
meson test
```

### Translate

After adding user facing strings, remember to wrap them `_("like so")`, from inside the `build` directory execute:

```sh
ninja hr.from.josipantolis.starfish-pot
ninja hr.from.josipantolis.starfish-update-po
```

## Package

Starfish is packaged with Flatpak and based on `io.elementary.Platform` runtime. In order to build it locally you may need to install the runtime first:

```sh
flatpak install --user io.elementary.Sdk//7
```

After that you can build and install Starfish itself with:

```sh
flatpak-builder build hr.from.josipantolis.starfish.yml --user --install --force-clean
```

And run it with:

```sh
flatpak run hr.from.josipantolis.starfish
```

## License

[GNU GPLv3](COPYING)