binoymichael / 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, and can be found at https://dayjot.com. As long as there is a single user paying $1/month, it will remain online.

• It emails you reminders, and allows you to customize exactly when these are sent.
• It accepts posts by email. Simply reply to a reminder email with your entry and it will be created.
• Included in each reminder email is an old entry, to remind you of that memory from last year, last month, or last week.
• Powerful search by term and/or month makes it easy to find that long lost memory.
• Enjoy multiple, beautiful ways to browse your journal. Skip to random entries, view by month, and more.
• OhLife importer. The perfect OhLife replacement, built to last. Easily import your OhLife entries.
• 1-Click export of all of your entries.
• It supports markdown formatting in entries and entry reminders.

The easiest way is to sign-up at https://dayjot.com ;).

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

• Ruby 2 (https://www.ruby-lang.org/en/)
• Rails 4 (http://rubyonrails.org/)
• Ember (http://emberjs.com/)
• Ember-Cli (http://www.ember-cli.com/)
• PostgreSQL (http://www.postgresql.org/)
• Mailgun (http://mailgun.com/)
• Delayed Job (https://github.com/collectiveidea/delayed_job)

1. Node 0.10.x (http://nodejs.org/)
2. Ember CLI

• npm install -g ember-cli

3. Bower

• npm install -g bower

4. Ruby 2.1.4

• I recommend instally and managing Ruby with RVM (http://rvm.io/). DayJot is setup to use RVM.

5. PostgreSQL

• Mac users, I recommend http://postgresapp.com.
• Windows users.. up to you.

1 Install the requirements listed above.
2 Fork this repository, and clone it to your machine.
3 Change into the dayjot/ember directory. Then run:

bower install
npm install

4 Change into the dayjot/rails directory.
6 Copy config/application.example.yml to config/application.yml, and fill in anything you want. The only required fields are DB_USERNAME and DB_PASSWORD. Then run:

bundle install
rake db:create
rake db:migrate
foreman start -f Procfile.local

7 Visit http://localhost:3000/ in your browser and you should be all set!

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

1. Fork it.
2. Hack it.
3. Test it.

• Rails tests are scaffolded and can be run from within the rails directory with the command "rspec".
• Ember tests have not been setup yet.
• There are very limited tests right now. More on this below.

4. Send a pull request.

The biggest issue right now is that there are no tests (for the Ember or Rails parts of the project). 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.com 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.