Code Monkey home page Code Monkey logo

nembrot's Introduction

Nembrot

Build Status Dependency Status Code Climate Coverage Status

Nembrot is a complete Rails 4 web application that takes notes from your Evernote notebooks and publishes them online. For more details see nembrot.org.

nembrot.org is actually a vanilla implementation of this code.

A fork of this code is used on the hosted service nembrot.com.

##Features

  • Syncs notes from any Evernote notebook
  • Converts youtube, vimeo and soundcloud links to embedded players
  • Embeds maps and organises notes geographically
  • Uses a small set of tags for managing displayed notes
  • Share links for Facebook, Twitter, GooglePlus
  • Detects note language and switches to right-to-left design, if applicable
  • Disqus or native comments
  • Account sign-in for comments using Facebook, Twitter, GooglePlus, Github, Linkedin, Evernote, or email/password
  • Organises notes by tags
  • Responsive theme
  • Google analytics.

Advanced (beta):

  • Marginal annotations
  • Diffed note versions
  • Bibliography
  • Links
  • Parallel display of translated notes.

Getting started

You will need to have Ruby > 1.9.3 installed on your machine. Clone this code and install the gems.

1. Get the code

$ git clone [email protected]:nembrotorg/nembrot.git
$ cd nembrot
$ rake db:migrate

2. Get an Evernote account

If you don't already have one, create an Evernote account.

3. Get an Evernote API key

Go to dev.evernote.com and request a new API key. After you've read everything you need to read, click on the green button at the top right corner. Your API key will need Full access, so choose that option. Nembrot does not synchronise all note data so do not check the box thats says, "This integration will sync all user data".

4. Create Evernote sandbox account

Your API key initially works only on the Evernote sandbox server. If you don't already have a sandbox account, create one now. Once you are signed in create a new notebook. Make sure the username you choose is the same as the one you enter in the settings.

5. Change settings

Make a duplicate of config/secret.sample.yml and rename it secret.yml. You will need to provide a value for all the settings that do not end with '_OPTIONAL'.

Duplicate config/channel.settings.sample.yml, rename it to channel.settings.yml and change the value for "notebooks" to the id of your Evernote notebook. To get this go to your Evernote sandbox account and click on the notebook. You will see that the url has changed to something like:

sandbox.evernote.com/Home.action#b=8a5bc592-8888-49d7-9ad9-7778f9b173dd&st=p

Your notebook id is the value for b in the query string, in this case 8a5bc592-8888-49d7-9ad9-7778f9b173dd.

Similarly, duplicate, rename and edit config/advanced.settings.sample.yml.

6. Start your server

Update the settings default:

$ rake settings:update_defaults

And finally, you can start your rails server!

$ rails s

7. Create a Nembrot user account

Click on the user icon at the bottom left of the page, or go to localhost:3000/users/sign_in. Sign in using your Evernote sandbox account. Nembrot will detect that the username for this account is the same as the one you entered in secret.yml and give your account an "admin" role.

8. Create your first note

Go back back to the notebook you created on your Evernote sandbox account and create a new note inside it. Add whatever you like as content: text, images, video links. Add a tag with the name __PUBLISH (note two underscres). This tells Nembrot to publish your note. Make sure you add at least 300 words or so. (By default, very short notes are not shown on index pages.)

9. Sync your first note

Later on, we will use a webhook to update automatically but in development we will simulate the webhook. On your Evernote sandbox account, click on the note you have just created. The url will change to something like:

sandbox.evernote.com/Home.action#n=028f4d7e-5ecd-4a82-81ea-0000a7c5d400&st=p

Now go to http://localhost:3000/webhooks/evernote_note?guid=**028f4d7e-5ecd-4a82-81ea-0000a7c5d400**. (Change the value for guid to the one shown for n in the Evernote sandbox url.)

And that's it! Go to localhost:3000 and you should see your first note on the homepage.

Going live

For instructions on deploying your site to production, see Going live.

Testing

$ rake settings:update_defaults RAILS_ENV=test
$ rake db:test:prepare
$ rspec spec

Guard is installed so you can also do: bundle exec guard

Contribute

This is still a relatively new project and there's still a lot to do. All contributions are hugely welcome!

Please report issues on the issue tracker.

  • Fork the project
  • Use a topic/feature branch
  • Make sure to add tests for your changes
  • Run "rspec spec" and ake sure all tests are passing
  • Open a pull request.

License

See LICENSE.txt for details.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.