diff --git a/README.md b/README.md index a6cff71..1ae6964 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,41 @@ +

+ preview of page +

+ +

+ Personal Journaling Platform +

+ +Sol Journal is a simple, minimal, journaling platform that works offline and across all devices. It can be self-hosted through Firebase and then installed as a PWA, on mobile devices for easy access on a phone, or on Desktops. Inspired by [JournalBook](https://github.com/trys/JournalBook) +

preview of page

-

- Sol Journal -

-A simple, minimal, journaling platform that works offline and across all devices. Installable as a PWA on mobile devices for easy access on a phone, inspired by [JournalBook](https://github.com/trys/JournalBook) +
-## 🚀 Getting Started +## Introduction -Sol Journal uses firebase to support offline functionality and authentication, a new Firebase app will need to be setup with Firestore as a database, be sure to add documents for `users` and `entries`, as well as enabling email for user authentication. +Journaling is a keystone habit that can improve your happiness and [overall health](https://psycnet.apa.org/record/2004-16777-010). Writing in a journal with pen and paper is effective, but not as easily accessible, maintained, or preserved. + +Having a journal that is available on any device makes journaling easier. Being tailored specifically to journaling makes it less cumbersome than trying to utilize a note taking app or document for recording thoughts and impressions. + +## Getting Started + +There are 2 ways to get started using Sol Journal: + +1. You can use the hosted version (this is the simplest way to use the product) on https://journal-app-service.firebaseapp.com/ +2. You can host your own version and manage it yourself + +Sol Journal uses firebase to support offline functionality and authentication, meaning a new Firebase app will need to be setup with Firestore as a database if you wish to host it yourself. Be sure to add documents for `users` and `entries`, as well as enabling email for user authentication. + +## Developing + +Clone the project: + +```bash +git clone https://github.com/gillkyle/sol-journal +``` Install dependencies: @@ -23,7 +49,7 @@ or yarn ``` -Then configure a file in `.env` with the following keys from firebase: +Then configure a file in a new `.env` file with the following keys from firebase: ```env REACT_APP_FIREBASE_API_KEY= REACT_APP_DEV_AUTH_DOMAIN= @@ -41,7 +67,7 @@ The site will be opened up in your default browser on http://localhost:3000 Edit code in the `/src`, save your changes, and they'll reload instantly in the browser. -## 🧐 Features +## Features In the spirit of minimalism, key features are what are in place for a quick, lightweight journaling experience that can work across devices, including: @@ -52,7 +78,7 @@ In the spirit of minimalism, key features are what are in place for a quick, lig - 💡 PWA: Being a progressive web app makes it installable from Chrome/Safari on desktop, or be added to the homescreen on iOS/Android - 🔌 Offline Support: Read/write when you're offline and let the updates happen when your connection is restored -## 💫 Deploy +## Deploy To create an optimized build of the site run this command: