Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.65 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.65 KB

Bookmarks Manager (WIP)

Code Climate

Synopsis

Offline (via Dexie and IndexedDB) bookmarks manager for the browser.

Features

  • Support for folders and nested folders
  • Support for tagging bookmarks
  • Can synchronize the database contents using SyncClient and SyncServer

Usage

  • Clone the repository
  • Install dependencies with npm install
  • Run npm start and navigate to localhost:3000 to start using the app
    • Optional: Use a different webserver. For this you need to set /dist as the root
  • Optional: run SyncServer
    • Use the settings menu to add a server url and port (optional) to be used for synchronization

What can be saved for a bookmark

  • URL
  • Title
  • Write date
  • Author
  • Description
  • Tags
  • Parent folder
  • Flag to set the bookmark as read

Browser Compatibility

The BookmarksManager was tested with newer versions of Chrome. Should also work in Firefox but was not explicitly tested there.

Contributing

If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please open an issue or pull request. If you have any questions feel free to open an issue with your question.

License

MIT License