Skip to content

Latest commit

 

History

History
129 lines (93 loc) · 4.3 KB

README.md

File metadata and controls

129 lines (93 loc) · 4.3 KB
Raw

CI Code Climate codebeat badge

unnote

Formerly known as Mykonote.

Full / Desktop

desktop

Mobile / PWA

mobile note mobile list

The note taking app that doesn't suck. Made under the Mykonian sun.

The goal of this project is to provide a solid note taking app with just the core functionality. There won't be any fancy unnecessary features such as a chat. It basically meets the one requirement: Taking and managing private notes.

What unnote offers:

  • A solid richtext editor which works properly without ruining the formatting
  • Task lists (aka. todo lists)
  • PWA, so it can be installed as an app on any mobile device
    • Support for the "share to" functionality of mobile phones. Pretty much any image or text based content can be shared to unnote.
  • Autosave
  • Permanent edit mode. There's no switching between read and edit mode. Just edit, always.
  • Pseudo offline support, so you don't lose data when the connection is bad or even missing. The next time the internet is up again your edits will be synced to the server.
  • A simple and fast user experience
  • An always available and easy to use search
  • A donkey logo
  • Free and open source software. There is no vendor lock-in and there will never be any weird business going on with your data.

Development setup

To get the application started the standard rails setup routine can be executed.

$ bin/setup

You can now start the application and give it a try at localhost:3000. There's a demo user [email protected] with the password asdfasdf.

$ bin/dev

Testing

For the capybara e2e tests headless firefox / geckodriver is used.

Make sure to build the client before running RSpec.

$ bundle exec rake client:build_and_deploy
$ bundle exec rspec spec

Releases (Versioning / Changelog)

Semantic Versioning is used, obviously.

There's a script that bumps the version, generates the changelog entry and creates a corresponding git commit / tag.

# bump the major version, e.g. from 1.2.0 to 2.0.0
$ bin/version bump:major

# bump the minor version, e.g. from 1.2.0 to 1.3.0
$ bin/version bump:minor

# bump the patch version, e.g. from 1.2.0 to 1.2.1
$ bin/version bump:patch

Changelog

For generating the changelog lerna-changelog is used.

To set this up locally you'll need to create the file .lerna-changelog-github-token containing a GitHub access token (with just the public_repo scope).

Links

License

Copyright 2016 Alexis Reigel <[email protected]>
Copyright 2016 Panter AG <[email protected]>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.