Skip to content

aerocyber/sitemarker

Repository files navigation

Sitemarker

An open source bookmark manager written in Flutter

Support

GitHub Sponsors and Buy Me a Coffee

GitHub Sponsors 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

Requirements

Install Flutter for building.

Fetch the dependencies using:

flutter pub get

Building

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

flutter pub run build_runner build
flutter build <dist>

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

⚠️ web is not supported and issues submitted will be closed without notice.

Releases

Checkout the 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

Get it from the Snap Store

Documentation

See docs here.

Reporting issues

Giving accurate bug report is essential for the continuous development of sitemarker. You can report all issues at Github 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. See Contribution Guidelines before opening a PR.

You can sponsor 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 <locale_code>.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

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.