Skip to content

andreaflether/bookmarkd

Repository files navigation

Bookmarkd Build Status Maintainability codecov GitHub license

Since Twitter only provides a single page to keep all your bookmarked tweets and usually, it takes forever to find a specific tweet in the middle of it all, extreme measures had to be taken. So, i present to you...

Bookmarkd! With it, you can create as many folders as you want and add the tweets of your choice, by just pasting the tweet link :)

Main features

📂 Save tweets of your choice in folders (a.k.a. Bookmark Folders)

Create folders by adding a name and a description. After that, just start adding tweets to it! The bookmarks will always be displayed in the order they were last added.

⚙️ Custom privacy

By default, only you have access to your folders/bookmarked tweets. However, you can choose to leave the folder public.

🔗 Folder sharing

If you chose to leave a folder public, you can copy its link and share it with the world! Other people seeing the folder will only have read privileges though, meaning only you can edit, add or delete bookmarks.

🌓 Dark and Light mode

Default is the Light mode, but you can change the application mode at any time.

🔢 Sort folders by Name, Last Update or Number of Bookmarks

The folders in the index page, by default, are sorted by the date they were last updated at, but you can also sort them by Name or by the Number of Bookmarks.

✋ No repeated bookmarks

Bookmarkd will tell you if the tweet you're trying to add already exists in the current folder.

📌 Pin folders

You can also pin a folder. They will always appear first in the index page (and the sidebar!).

👩‍💻 Sign up via Bookmarkd or Twitter

It is possible to create an Bookmarkd account or log in via Twitter.

Technology

  • Ruby 2.5.5
  • Rails 5.2.4

Gems

Packages

  • Bootstrap for design and responsiveness. Other Boostrap related packages were also used, such as:
    • Bootstrap MaxLength for a better and readable indication to the user when a input has a specified max-length in it.
    • Bootstrap Show Password to allow the user to show/hide the value in a input with the password type.
  • EasyAutocomplete to show results as the user types, in the 'Quick access' feature.
  • ImagesLoaded and Isotope:
    • Display folders in a grid layout and show a smooth animation when performing a action on a folder (pin/unpin/delete).
    • Sort folders by Name, Updated At and Number of Bookmarks.
    • Filter (Search) a folder.
  • Font Awesome for icons.
  • JQuery and JQuery UI to simplify Javascript functions and an easier integration with Ajax.
  • Tippy to display sum up guides in tooltip form, in order to help the user understand on how the application works.
  • Toastr for alerts and/or notices.

Check package.json file

License

The project is available as open source under the terms of the MIT License. Copyright © 2020, Andréa Alencar.

Contributing

  1. Fork it (http://github.com/andreaflether/bookmarkd/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Please write tests for anything you change, add or fix.