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