|Bookmarklet||Chromium Extension||Firefox Addon||IntelliJ Plugin||VSCode Extension|
The other extensions function more or less after the same principle
Worthy public bookmarks are published regularly on Github at codeverland/bookmarks.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
The project is developed with the MEAN stack and Keycloak for authentication and authorization:
The project contains two parts
What you need to run this app:
npm(we recommend using NVM)
v10.x.x+) and NPM (
npm install -g nodemon
Docker and Docker-compose are currently used only for local development
⚠️ When you run
docker compose for the first time uncomment the following
-Dkeycloak.migration.action=import line :
#command: -Dkeycloak.migration.action=import -Dkeycloak.migration.provider=dir -Dkeycloak.migration.dir=/tmp/keycloak/export-import -Dkeycloak.migration.strategy=IGNORE_EXISTING
in the docker-compose file, so that the initial Keycloak setup (realm and users) is loaded.
⚠️ For further startups of docker-compose you should comment back this line, as it starts faster
-dto run it in the background
You want to have the backend API running first with the following commands:
# install nvm use #only if you are using nvm npm install # run npm run frontend #to run the frontend npm run backend #to run the backend #alternatively run in parallel npm start
or in one line
nvm use; npm install; npm start
mock/mockconfigured for you in the initial Keycloak setup. Some bookmarks are initially loaded with your account, so you can start playing with them.
You can create your own test user, or any other extra users by following the screenshots in Add a Keycloak user to create it.
To be able to automatically add youtube videos published date and duration to the title you need to create a nodemon.json file based on the backend/nodemon.json.example and your own youtube api key
Keycloak and mongodb have to be started as specified above (
Run the integration test by issuing the following command.
cd backend; npm run integration-tests
A report will be generated.
You can use the Dev Tools in Chromium based browsers (e.g. Chrome, Brave). Navigate to Sources and the file you want to set your break points, like in the following example:
npm run debug starts nodemon with the
--inspect parameter so you can attach to this process, by using the following configuration:
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
The changelog is available in CHANGELOG.md
To update the changelog execute the following commands:
nvm use standard-changelog
This project is licensed under the MIT License - see the LICENSE file for details.
All media materials used in the project fall under the copyright law