Skip to content

dermatthias/journal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Journal: A simple personal journal

Introduction

This is a simple Flask webapp to keep a daily journal, or at whatever interval you like.

This is inspired by the book '59 seconds' by Richard Wiseman and the blog post 'Keeping a journal' by Zach Holman (@holman). They both emphasize the importance to keep a journal, both for remembering things, reliving memories and to keep you happy (read Richards book and the chapter on happiness).

Demo

I have a demo journal running at http://journal.flurp.de, which resets it's database every 30 minutes.

Features

I wanted to make this really simple to write entries and to save only the most important metadata of an journal entry (location, date and, on the TODO list for this webapp, photos).

So all you do is write your entry (markdown support here!), place a marker on the map and you are done.

Please note that this webapp does nothing in respect of authentication, authorization or anything like that. If you run it on a public server, everyone will be able to see, edit or delete your entries. I run my journal on a Raspberry Pi on my local network at home. Work really well.

Setup

This is a Flask app. So basically all you need is to setup flask, install the dependencies (see below), init the database and run flask:

(start a python shell, like 'python' or 'ipython')   
import journal
journal.db.create_all()

(quit the shell, run the following command:)

python journal.py

This starts the Flask development server, which could be enough for your usecase. But its also possible to set it up via wsgi/nginx, apache, etc. You name it. It's just a default python webapp. The Flask documentation gives a good overview for all kinds of deployment types.

Dependencies

  • Flask
  • Flask-SQLAlchemy
  • markdown2

(all available via pip)

TODO

  • Photos
  • Live markdown preview

License

(The MIT License)

Copyright © 2014 Matthias Schneider

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A simple personal journal

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published