An open source bookmark manager written in Flutter
Code contributions are always welcomed! Please see the Pull Request Guide in the documentation to how to pull a PR for Sitemarker
Install Flutter for building.
Fetch the dependencies using:
flutter pub getBuilding 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.
Or, alternatively, run:
./build.sh # For all builds.Checkout the releases page and obtain the latest stable release!
The following packages are (or will be) available via package managers:
Giving accurate bug report is essential for the continuous development of sitemarker. You can report all issues at Github Issues.
The following features are not completed.
- Themes Settings: Dark theme, light theme and system preferred.
- Save settings: Save the settings using shared_preferences and make it load on start up
- Introduction screen for new users
- Import/Export of data to/from internal database
- Migration assistant for Sitemarker 1.x to 2
- Recognize URLs without protocols
- Sort based on Tags
- Copy URL to clipboard
- Localization
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 guidelines exist to help contrbutors to make contribution to the right place.
There exist different ways to contribute.
-
All code commits MUST go to
devbranch. They must have a tag which suits the need, sayFeaure Implementation,Enhancement,Bug fix. -
All translations MUST go to
devbranch. They must have a tag ofTranslation. All translations are in thetranslationsdirectory in the root 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.
MIT License
Copyright (c) 2023 Aero
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
