Skip to content

Have you ever wanted to self-host a web application just to replace something you could do with a notebook and a pencil?

License

Notifications You must be signed in to change notification settings

olafal0/pjournal

Repository files navigation

pjournal

Have you ever wanted to self-host a web application just to replace something you could do with a notebook and a pencil? So have I.

pjournal is a web app for keeping a personal journal—like a blog that only you can see. It supports multiple users, full GitHub-flavored markdown, editing, and client-side encryption. Set a local encryption password, and all new or updated posts from that point forward will be encrypted before they're sent to the server!

You can try it out here: https://journal.olafalo.net

pjournal screenshot

pjournal is made using dispatch, Parcel, Svelte, and Marked.js.

Deploying

Prerequisites:

  • An AWS account
  • Correctly configured awscli (or AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY set if running from GitLab CI)
  • jq installed
  • (Optional) Somewhere to host a static website (GitHub/GitLab pages, Netlify, etc)

Once everything is set up, just clone this repository, cd into it, and run:

./scripts/deploy.sh # Deploy the backend on AWS
./scripts/generate-config.sh # Generate website configuration from the deployed backend
cd web # Change to the frontend directory
npm install # Install dependencies
npm install --global parcel-bundler # Install the parcel CLI tool
parcel index.html # Run the site locally for testing

You can then view the website locally (on http://localhost:1234 by default). The website will automatically be configured to use the your backend stack on AWS, so you can register and start using it! To host the site somewhere, you'll just need to build the site with parcel and upload the resulting files to any kind of static site host.

About

Have you ever wanted to self-host a web application just to replace something you could do with a notebook and a pencil?

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published