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

https://github.com/aerocyber/sitemarker

An elegant bookmark manager
https://github.com/aerocyber/sitemarker

android bookmarks flutter hacktoberfest hacktoberfest-accepted linux offline open-source sqlite3 windows

Last synced: about 2 months ago
JSON representation

An elegant bookmark manager

Awesome Lists containing this project

README

          

# Sitemarker

An open source bookmark manager written in Flutter

## Support

### GitHub Sponsors and Buy Me a Coffee

![GitHub Sponsors](https://img.shields.io/github/sponsors/aerocyber?style=for-the-badge&label=GitHub%20Sponsors&link=https%3A%2F%2Fgithub.com%2Fsponsors%2Faerocyber)

Buy Me A Coffee

### Code contributions

Code contributions are always welcomed! [Please see the Pull Request Guide in the documentation to how to pull a PR for Sitemarker](./docs/issues_and_pr.md#pull-requests)

## Requirements

Install [Flutter](https://flutter.dev) for building.

Fetch the dependencies using:

```bash
flutter pub get
```

## Building

Building is as simple as running the following command in the root of the project dir:

```bash
flutter pub run build_runner build
flutter build
```

where `dist` is one of the option in `flutter build` subcommands.

:warning: web is not supported and issues submitted will be closed without notice.

## Releases

Checkout the [releases](https://github.com/aerocyber/sitemarker/releases) page and obtain the latest stable release!

### Distribution packages

The following packages are (or will be) available via package managers:

[![Get it on Flathub](https://flathub.org/api/badge?locale=en)](https://flathub.org/apps/io.github.aerocyber.sitemarker)

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/sitemarker)

## Documentation

See [docs](docs/index.md) [here](https://aerocyber.github.io/sitemarker).

## Reporting issues

Giving accurate bug report is essential for the continuous development of sitemarker. You can report all issues at [Github Issues](https://github.com/aerocyber/sitemarker/issues).

## Yet to be completed

The following features are not completed.

* Import/Export of data to/from internal database
* Sort based on Tags
* Localization

## Contribution

For all contributions to this project, please [open a pull request](https://github.com/aerocyber/sitemarker/pulls). See [Contribution Guidelines](#contribution-guideline) before opening a PR.

You can [sponsor](#Support) the project as well!

### Contribution Guideline

Contribution guidelines exist to help contrbutors to make contribution to the right place.

There exist different ways to contribute.

* All code commits MUST go to `develop` branch. They must have a mention in the title what the code is for, say `[Feaure Implementation]`, `[Enhancement]`, `[Bug fix]`.

* All translations MUST go to `develop` branch. They must mention `[Translation]` in PR title. All translations must be in the `translations` subdirectory in sitemarker dir.

The translations can be done by copying `base.json` to your `.json` file and editing them. Please make sure to **_COPY_** and NOT MOVE the base.json file.

_Note: translations are not available as part of Sitemarker 3.0.0_

## License

```text
The entire project, from version 3.0.0 is licensed under the terms of Apache 2.0 license.
See LICENSE file for the entire license text.
```