- running in a production environment
- You have node.js >= 6 installed
- You have npm >= 5 installed
- You either have postgres running, or have docker-compose installed
As of version 3, all configuration is done through environment variables. For the list of environment variables, see .env.sample.
via docker (recommended)
# using an env file docker run --env-file .env beardfury/bkmrkd # specifying env vars separately docker run \ -e DB_HOST=localhost \ -e DB_NAME=bkmrkd_development \ ...etc
Simply drag the bookmarklet to your bookmarks bar and click it on a webpage you want to save.
running in a production environment
So you want to run this for real. On the web. That's awesome. Everyone will want this to be setup differently, but this is how I've approached it.
- Create an hosted PostgreSQL DB solution (Amazon RDS, Azure, Google, etc)
- Deploy to now
To work on bkmrkd locally, you'll want to start the node server for back end dev, the elm watcher for front end dev, or both.
# create the env file cp .env.sample .env # if you have docker and docker-compose installed docker-compose up -d # create the test database createdb -h localhost -p 5432 -U postgres bkmrkd_test # start the server in development mode npm start | ./node_modules/.bin/bunyan # start the elm watcher npm run watch:elm
The migration from 2.0 to 3.0 is pretty simple thanks to the awesome export capabilities of RethinkDB.
First, you'll want to download your existing bookmarks. From the computer with RethinkDB installed, dump the production database.
rethinkdb dump -f db-dump.tar.gz -e bkmrkd_production
Once it's dumped and downloaded to your computer (or do this remotely if you want), untar the tarball and look for the JSON file with all your bookmarks. Once you have that, run the migration script and assuming your
.env file is currently pointed towards production, it should all work smoothly.
To keep track of the roadmap, I'm using issues.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.