Stars: 1590
Forks: 193
Pull Requests: 38
Issues: 247
Watchers: 59
Last Updated: 2022-11-26 22:16:03
An open source to do app for bookmarks.
License: Other
Languages: JavaScript, PHP, HTML, CSS, Dockerfile, Hack, SCSS
The open source to-do application for bookmarks.
NOTICE June 15, 2020: The new default branch is named "trunk". ✊
We offer this source code for Unmark completely free. We do so in hopes that Unmark will live on for many years even if we stop maintaining it. You can also use it for free (with a paid upgrade) at Unmark.it
To support its further development please consider subscribing to Unmark.it, donating via Paypal. Or, you can contribute to the code.
Running Unmark is only recommended for intermediate users. This doesn't mean if you're a beginner we don't want you to try. Hack away! Just that you should expect some speedbumps (though, we're eliminating them all the time). If you need assistance beyond what is provided please create an issue on Github. Before creating a new issue we recommend search through the issues on GitHub to see how others have solved their problems.
It is now recommended to use Docker / Docker Compose to install and run Unmark locally both for personal use and for development. Please see the installation instructions section below.
However, if you're going to run your own server:
Some common issues have been reported. Some are trying to load Unmark on a sub-directory, using different versions of PHP or Apache, or using completely different databases. While it may be possible to do so, expect issues.
Other common things that come up:
We've included the appropriate Docker Compose, Dockerfile, and PHP.ini files to run Unmark locally on Windows or Mac with almost zero set up. We've been using Docker on both Windows and Mac for the last two releases and we like it. However, this is still in its early phases so please report any issues that you find.
Warning: Running docker-compose down -v
will erase Docker volumes including your local database. If you do not include the -v argument your database will remain intact. If you need to run -v log into Unmark and export your marks first.
/application/config/database-sample.php
to /application/config/database.php
docker-compose up -d
(to shut Unmark down run docker-compose down
)git clone https://github.com/cdevroe/unmark.git
(Or, if you've forked the repo, use your URL)/application/config/database-sample.php
to /application/config/database.php
(leave database-sample.php
in place)/application/config/database-sample.php
to /application/config/database.php
docker-compose up -d
(to shut Unmark down run docker-compose down
)npm install
grunt
more info on Grunt
No longer recommended, but do whatever you want!
/application/config/database-sample.php
to /application/config/database.php
/application/config/database.php
your-local-url/setup
docker-compose down
/application/config/database.php
intact.)git pull origin trunk
npm update
in the app's root directorygrunt
in the app's root directoryUnmark currently supports importing from Unmark's hosted version, any self-hosted version of Unmark, Readability, Pinboard, Delicious, Pocket and many other services.
To ensure this works properly be sure that your PHP.ini file's "max_upload_size" setting is larger than the file you're trying to import.
Please consider donating via Paypal. Another major way you can contribute is to report any issues you find with Unmark on Github and being as detailed as possible about the issue you're having.
Another way is to contribute your own code via Pull Requests. Here are some notes on how to do that.
git checkout -b your-branch-name
git push origin your-branch-name
This makes it easy for us to test your code locally and also allows the community to have a discussion around it.
We use Grunt to compile our SASS files into CSS and concatenate and compress our JavaScript files for use and a few other small tasks. For any updates to JavaScript or styles you will need to use Grunt too. See the Grunt web site for help. We'd like to someday move away from Grunt for most of these tasks.
Unmark was originally created by Colin Devroe. It was a side-project called Nilai (the Indonesian word for "mark") and rebuilt from the ground up by Plain, a small software company, which included Jeff Johns, Kyle Ruane, Tim Whitacre, Chris Fehnel, Jakub Jakubiec and Colin Devroe.
Now it is being maintained by Colin, Kyle and the community in their spare time. Please consider donating or contributing code in order to keep Unmark alive and well.
Currently being maintained by: @cdevroe and @kyleruane.
Extra special thanks to:
Also contributions by @thebrandonallen, @simonschaufi, @williamknauss, @hewigovens