raucao / webmarks

remoteStorage-enabled bookmarking app

Webmarks

Webmarks is a bookmarking app, which lets you choose your server or provider for storing all data. It is a user-first, open-source alternative to proprietary, hosted bookmarking services like e.g. Delicious, Pinboard, et cetera. Learn more.

Every contribution and all feedback are much appreciated and will be responded to timely. The rest of this README concerns only developers and potential contributors. For general support requests, please open an issue.

Translations

The app is currently available in the following languages:

• English
• German
• French

Webmarks will use your browser language settings to determine which language is shown.

Translating the app to a new language is simple:

1. Copy a language folder in app/locales/ to a new one, using the two-letter ISO code of the language
2. Edit app/locales/[language]/translations.js.
3. If you want to test the translations, run the app locally (see below for instructions) and open it in a browser that is set to the language you added.

Development

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node.js (with npm)
• Ember CLI
• Google Chrome

Installation

• git clone <repository-url> this repository
• change into the new directory
• npm install

Running / Development

• npm start
• Visit the app at http://localhost:4200.
• Visit the tests at http://localhost:4200/tests.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

• npm test
• ember test --server (recommended)

Linting

• npm run lint:hbs
• npm run lint:js
• npm run lint:js -- --fix

Building

• npm run build (development)
• npm run build-prod (production)

Deploying

Build production branch and deploy to staging:

npm run deploy

Deploy current production branch to production:

npm run deploy-prod

Further Reading / Useful Links

• remoteStorage
• remoteStorage.js API docs
• ember.js
• ember-cli
• Development Browser Extensions
  • ember inspector for chrome
  • ember inspector for firefox
• Material UI icons

webmarks's Issues

Improve search

Hello,

Could it be possible to search using several words ?
For example I search for "work", it gives me 30 links.
I then would like to enter space, then "servers", so that my list is shortened to the links containing both "work" and "servers".
Etc...

Many thanks 👍

Ben

Integrate with Firefox's share services

See e.g. Known for how to just load the remote site in the share window and prefill form fields.

https://activations.cdn.mozilla.net/en-US/

Upgrade to rs.js 0.10

... as soon as it's stable enough.

Bookmark list not loaded when entering app from bookmarklet

Upgrade to Ember CLI, Ember 2.0 etc.

Set up deployment

We used to use grunt-build-control, but latest master is now using ember-cli, so the old deployment script doesn't work anymore.

Error when editing a bookmark

When I edit a bookmark, but don't change any of the tags, I get the following exception:

Uncaught TypeError: Object [object Array] has no method 'split' 

Auto focus

Hello,

Would be nice if "search" field could be auto-focused.
And when we click "+" to add a bookmark, would be nice to focus the first field (title).

Many thanks 👍

Implement Web Share target

We can implement the new Web Share API to make Webmarks a native sharing target on Android, after registering it as such from Chrome. See e.g. Mastodon's implementation: mastodon/mastodon#6278

Spec: https://wicg.github.io/web-share-target/

Add to http://emberwatch.com/open_source.html

... as soon as it's in state where we want to promote it as an example Ember app.

Import from other places

Is there an easy way to import bookmarks from other places?

Or maybe there's a way to inject the data directly on remoteStorage, but what is the format the data is expected to have?

Problems building

Thought I'd try webmarks too, as you mention using it regularly but I'm having problems with setup when I get to npm install:

First error is:

bower ember-resolver#master                       error Path must be a string. Received [ '/tmp/mrh/bower/ember-resolver-6624-gupSb6',   [Function: _cleanupCallback] ]

Towards the end I also have:

System info:
Bower version: 1.2.8
Node version: 6.2.0
OS: Linux 3.16.0-4-amd64 x64

npm ERR! Linux 3.16.0-4-amd64
npm ERR! argv "/usr/local/bin/node" "/usr/local/bin/npm" "install"
npm ERR! node v6.2.0
npm ERR! npm  v3.8.9
npm ERR! code ELIFECYCLE
npm ERR! [email protected] postinstall: `bower install`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] postinstall script 'bower install'.
...

I'm lost with this stuff. Any ideas?

do not require title field, auto fetch it

would it be difficult to have webmarks only require the URL and fetch the <title> of the page directly by itself? Or does CORS prevent this?

Select text in search field

Hello,

This feature request follows #46.
Would be nice for the text (inside the search field) to be selected when the search field is focused.
So that we can then search for something else very quickly when we come back to the Webmarks page.

Many thx 👍

Ben

Confirmation to delete

Hello,

Would be nice to have a confirmation request before deleting a bookmark.

Thank you !

Ben

Webmarks seems to like memory

Hello,

Webmarks eats a lot of memory :

Thank you !

Ben

Add different types of bookmarks

Locations would be nice for starters (maybe just add lat/lng).

Improve onboarding

No CORS info in Apache 304 responses

Hi,

I'm facing this issue where 304 Apache responses do not include CORS info :
https://bz.apache.org/bugzilla/show_bug.cgi?id=51223

I use Webmarks with @fkooman PHP remoteStorage implementation.

Due to this "bug", Webmarks disconnects quickly :

Is there any workaround ?
Perhaps requests leading to 304 answers could be avoided / replaced by requests leading to 200 answers (but this could perhaps generate more traffic) ?

Thank you 👍

Ben

Search of tag not functioning

No answer if I search a tag.
The console displays an error (see at the bottom)
Can You help me?
Thanks
Stefano from Italy

rs.on ready
webmarks-d361a083d843f6d2225cceb55d52a5a7.js:1:20491
rs.on connected
webmarks-d361a083d843f6d2225cceb55d52a5a7.js:1:20544
[storage] Writing tag list to localStorage ["50+50w","Aaron","Amazon","Calibre","DAC","DDNS","DNS","DVD","Domotica","Hole","LNR","Laharah","Libri","PM10","Peterlini","Pi","Python","Raspberry","Raspberry Pi","Raspi","Raspy","Sergio","Server","Swartz","Vimeo","accedere","accesso","acquisti","amplificatore","autore","biblioteca","bird","blocco","blog","bluetooth","book","books","calibre","catalogo","cd","cinema","comandi","control","controllo","copertina","copertine","debian","descrizione","diritto","disabilitare","documentazione","doppiaggio","download","ebay","editor","elegiant","film","find","forwarding","fusione fredda","giornali","gratis","hifi","informatico","inquinamento","lastampa","lettera22","libreria","libri","libro","limes","linux","ma video","manuale","meditazione","micromega","misurazione","naked","news","no-ip","noip","noleggio","notizie","online","panel","pannello","politica","polveri","port","porte","pubblicità","python","raspberry","raspi","raspy","rent","rivista","rocco","scheda","scienze","server","shopping","sinossi","software","sottili","spiritualità","stampa","streaming","temperatura","terminale","torino","touchpad","trovare","uccello","zeus"]
webmarks-d361a083d843f6d2225cceb55d52a5a7.js:1:21300
TypeError: n.title is undefined[Ulteriori informazioni]
webmarks-d361a083d843f6d2225cceb55d52a5a7.js:1:6664

Upgrade to Ember 3.0

Error when autocompleting tag with TAB

When hitting TAB to autocomplete a tag, the following error is thrown:

Uncaught TypeError: Cannot read property 'menu' of undefined

Error is happening in this line: https://github.com/skddc/webmarks/blob/6727e97d124ad44e771bc8b2dd14cdeb22958af0/app/components/bookmark-form/component.js#L21

I thought I tested tab completion when reviewing the PR, but I'm not sure yet if I only used ENTER.

Permalinks for searches/tags

it would be pretty neat to be able to share links to a subset of the stored bookmarks.
Meaning having a URL that directly filters the bookmarks for a certain tag. - for example: https://webmarks.5apps.com/[TAG]

I did not know how to implement it, so I am opening this issue. Maybe someone can give me some hints on how to implement that feature.

Open links in new tabs

Hello,

Would be nice if we could open links in new tabs by default.

Many thanks 👍

Fix bookmarklet for sites where it currently fails

On a handful of sites with very restrictive CSP the bookmarklet currently doesn't work at all. Among those is GitHub and the Firefox addon directory, so it's pretty annoying for power users.

Upgrade Ember and EAK

Remove requirement to connect storage before adding bookmarks

... and add some kind of indicator/message that they're not synced unless connected.

Adding bookmark via bookmarklet results in only that one being shown on index

... until it is either deleted and the route then reloaded, or otherwise until the whole app is reloaded.

bookmarklet not working with HTTPS urls

tested with github:

https://github.com/veox/sgminer/issues/20

on fedora 20 / firefox 26

Make Webmarks less active if not focused

Hi,

Even if in a background/hidden tab, so not focused, Webmarks regularly updates itself :

Thus making it a top energy consumer on a laptop.

Could it be possible to make it less active / not active while not focused ?

Thank you very much 👍

Ben

Android version

remoteStorage.js now supports Cordova apps using an in-app browser window for the connect. It would be great to package Webmarks for Android and add the necessary functionality to make the native "share" feature work with it. Then you could save bookmarks from any other Android app directly to your remote storage.

Needs #25 and #8 at least.

Make layout responsive/usable on mobiles

Newly created bookmark not added to list directly

When I create a new bookmark, it's not added to the list directly. I have to reload the page to see it.

This happens with the current master.

Re-focus after click

Hello,

Search field is auto-focused, which is perfect, we just have to type after having reached the Webmarks tab for the first time, and click on the link we want, which is then opened in a new tab. Perfect.
However, when we come back to the Webmarks tab, search field is not focused anymore, because we previously clicked on one of the links in the page.

Do you think it could be possible to automatically "re-focus" the search field ?

Thank you very much 👍

Ben

Improve Ember.js usage

Move model loading to route, use loading routes, etc.

Bookmarklet doesn't work

When coming via the bookmarklet, I get immediately routed to the index.

Analytics

E.g. https://piwik.org/blog/2017/02/how-to-track-single-page-websites-using-piwik-analytics/

Piwik has the option to honor DNT, and to anonymize IPs, so that would be my preferred way.

Can't drag the bookmarklet in Chrome

The pure-button class for the link adds a setting -webkit-user-drag: none; to it.

Add autocompletion for tags

To make it easier to re-use existing tags, it would be great to some form of autocompletion.

Add general info page to app

It should explain who's developing Webmarks, where to get support, how to install it as PWA, how to tip devs, and so on.

Add Promise polyfill

I deployed Webmarks with rs.js 1.0 to production, but forgot to add a conditional polyfill for Promises. So it will break in browsers without Promises now.

Previews for OEmbed-enabled URLs

Form validation error style by default in FF

I just upgraded to Ember 2.10.0 and then saw a weird issue during testing (not sure if it was there in master before): when going to /new in Firefox, the required fields are already marked invalid, even before trying to submit the form:

Use `BaseClient#getAll` in addition to change events

Also, use loading route for while it's doing it's thing. Should be a walk in the park thanks to Ember being promise-aware.

Exception and infinite loading spinner on empty storage

Update: this only happens in the update_remotestorage branch, with newer deps overall. Fixing it there.

There's currently an exception when loading the app with no boomarks stored (at least after deleting all existing ones):

Don't redirect to overview/list when creating bookmark

At least not when coming from the bookmarklet. That way one doesn't have to re-validate the whole index just to see the list as "confirmation" that the bookmark was saved.

Improve rendering performance for large bookmark collections

When one has a ton of bookmarks, due to the fact that they're all rendered at once on the index, the rendering can take quite some time, which is delaying switching to the page.

My current idea for solving it is to limit the number of items rendered. But that means there needs to be some kind of button for loading more when scrolling to the end, or an infinite scrolling implementation.

Error on changing tags in `bookmark/edit` and canceling

When you edit a bookmarks tags (e.g. add a space after the comma) and click "cancel" it throws a JS error and the app chokes on it.

Localize whole application

Maybe these could be helpful:

• https://hacks.mozilla.org/2014/01/localizing-the-firefox-os-boilerplate-app

Index route failing when no tags present

Error while processing route: bookmarks.index reduce of empty array with no initial value e.default<.createTagListCache@https://webmarks.5apps.com/assets/webmarks-b99e47dd79560d62057a48fe6d2c8c02.js:1:16909