https://github.com/raucao/webmarks

remoteStorage-enabled bookmarking app
https://github.com/raucao/webmarks

bookmarks-manager ember emberjs javascript pwa remotestorage spa unhosted

Last synced: 19 days ago
JSON representation

remoteStorage-enabled bookmarking app

• Host: GitHub
• URL: https://github.com/raucao/webmarks
• Owner: raucao
• License: other
• Created: 2013-06-27T11:09:58.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-03-26T14:15:31.000Z (over 1 year ago)
• Last Synced: 2024-10-15T06:42:38.098Z (21 days ago)
• Topics: bookmarks-manager, ember, emberjs, javascript, pwa, remotestorage, spa, unhosted
• Language: Handlebars
• Homepage: https://webmarks.5apps.com
• Size: 5.72 MB
• Stars: 76
• Watchers: 9
• Forks: 11
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - raucao/webmarks - remoteStorage-enabled bookmarking app (Handlebars)
• awesome-starred - raucao/webmarks - remoteStorage-enabled bookmarking app (javascript)

README

        
# 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](https://webmarks.5apps.com/about).

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](https://github.com/skddc/webmarks/issues).

## 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](https://git-scm.com/)

* [Node.js](https://nodejs.org/) (with npm)

* [Ember CLI](https://ember-cli.com/)

* [Google Chrome](https://google.com/chrome/)

### Installation

* `git clone ` this repository

* change into the new directory

* `npm install`

### Running / Development

* `npm start`

* Visit the app at [http://localhost:4200](http://localhost:4200).

* Visit the tests at [http://localhost:4200/tests](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](https://webmarks-dev.5apps.com):

    npm run deploy

Deploy current production branch to [production](https://webmarks-dev.5apps.com):

    npm run deploy-prod

### Further Reading / Useful Links

* [remoteStorage](https://remotestorage.io/)

* [remoteStorage.js API docs](https://remotestoragejs.readthedocs.io/)

* [ember.js](http://emberjs.com/)

* [ember-cli](http://ember-cli.com/)

* Development Browser Extensions

  * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)

  * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)

* [Material UI icons](https://material.io/tools/icons/)