Skip to main content

A simple journal for use at home by the family

Project description

Home Journal

A self-hosted mini journaling site for families for capturing

  • memories
  • stories
  • photos
  • ideas
  • jokes
  • and anything else you want to remember

I had an old wordpress blog that I converted to markdown files and needed a way to view the posts. I was looking for something self-hosted and simple. Some of my design requirements were:

  • Mobile friendly and easy to post from mobile
  • Need to look and feel like a mobile app
  • Needed to be all static files, or as close as I could get
  • Needed to be markdown based
  • Needed to have a sane directory structure
  • No authentication or social auth since this is self-hosted
  • No database
  • No javascript frameworks
  • Minimal dependencies
  • No need to edit posts from the UI
  • No need to delete posts from the UI
  • Ability to regenerate all html files
  • Ability to add new posts with a text editor

What's working

  • Index page
  • Post page
  • New post page
  • Tags page
  • Progressive web app (PWA) support (requires https)
  • PWA as share target
  • Responsive design
  • Rebuild static html files (http://your.server/all)
  • Static files for all but new entry submission
  • Github style markdown formatting

Future enhancements

  • Support for videos and other file types

Installation

  • Clone the repo
  • Copy the sample_site directory to your desired location, it will be the directory for all content
  • Build and source a virtual environment
  • Install from the source directory pip install .
  • Run the server `home-journal -sd /your/site/root --tags cars,people,boats,nature
  • Enjoy (http://your.server:8000)

Thank you

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

home_journal-0.0.2.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

home_journal-0.0.2-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file home_journal-0.0.2.tar.gz.

File metadata

  • Download URL: home_journal-0.0.2.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for home_journal-0.0.2.tar.gz
Algorithm Hash digest
SHA256 904abb3bfeff1255c7124ab950d313a0a3accf49716cab5f908c075a723d1c81
MD5 82f1abbc8ddb2af07e010680ef27239b
BLAKE2b-256 12a2dda68e8a9258dd9cd622de60b63e8b8e21632237734d612b844354e61e53

See more details on using hashes here.

File details

Details for the file home_journal-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for home_journal-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 012623fd4119d78d3ff1d57ae5f1e627c27ce046429e4b60d45666d2c74f315e
MD5 02ae4f35a924630ed07734c1b8a8c54c
BLAKE2b-256 0d3ed2165a1e86b09220fbadf252b7fbe9d42068c43c1155a08ac622305ade7c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page