ibnumubarok / dayjot Goto Github PK

DayJot is a simple, private journaling app. It's built to provide many features that were included in the (now defunct) OhLife journaling app. The hosted version of DayJot will be run forever. As long as there is a single user paying $3/month, it will remain online.

• Customizable email reminder system.
• Reply to reminder to make a post
• Powerful search
• Multiple, beautiful ways to browse your journal.
• Easy OhLife importer.
• Easy export of all entries
• Supports Markdown

The easiest way is to sign-up at DayJot ;).

To get it running on your own machine, here's what you need to know:

• Ruby 2
• Rails 4
• Ember
• Ember-CLI
• PostgreSQL
• MailGun
• Delayed Job

Please note that you must be on Node 0.10.x to run DayJot.

1. Install Node 0.10.x, I recomment installing via n
2. npm install -g [email protected]
3. npm install -g bower
4. Ruby 2.1.4, I recommend installing via RVM
5. gem install foreman
6. PostgreSQL

This script provides an easy way to install the above dependencies.

After you have cloned this repo, and installed the dependencies above, run this setup script to set up your machine with the necessary dependencies to run and test DayJot:

% cd rails && ./bin/setup

After setup, you can run the application from the rails directory with:

% foreman start -f Procfile.local

You should be set to use the app at http://localhost:3000.

Relevant config variables can be found in the rails/config/application.yml file.

Depending on your PostgreSQL setup, you may need to update the DB_USERNAME and DB_PASSWORD properties in rails/config/application.yml.

Gee I'm so glad you asked that, great question!

1. Fork
2. Hack
3. Test (Rails tests can be run via rspec; Tests haven't been setup for Ember)
4. Send a pull request.

The biggest issue right now is that there are very few tests (none for Ember and just a skeleton for Rails). Coincidentally, writing tests is one of the best ways to familiarize oneself with a new codebase.

I would be very grateful to anybody who's up for writing tests for this project. In fact, for anybody who submits a PR with one or more tests (one is fine!), I'll set you up on DayJot for free, for life.

Please direct any questions, concerns, or general chat to [email protected]. I'm also available on Twitter at @marbemac.

DayJot is released under the GNU V2 License.