From 9a3a6b5923693f52b7a08d5afbff603fce8e8ca9 Mon Sep 17 00:00:00 2001 From: gillkyle Date: Mon, 22 Apr 2019 23:17:45 -0700 Subject: [PATCH 1/2] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4bd113d..5e3114e 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,18 @@ There are 2 ways to get started using Sol Journal: 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. +## 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: + +- 🔥 Authentication: Cloud firestore persists registered users to a users document and saved journal entries to an entries document +- 🎨 Dark Theme: the `src/styles/theme.js` file contains a set of colors and default styles that are applied to components with Emotion. A default light and dark theme are already in the file +- 🔍 Search: full-text search of a user's entries stored in Firestore for quick access to past entries +- 🖥 Mobile Friendly: designed to look great on mobile as well as desktop, with easy navigation on both +- 💡 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 +- 🗄 Export: backup all of your entries at any time to save your data + ## Developing Clone the project: @@ -64,18 +76,6 @@ 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 - -In the spirit of minimalism, key features are what are in place for a quick, lightweight journaling experience that can work across devices, including: - -- 🔥 Authentication: Cloud firestore persists registered users to a users document and saved journal entries to an entries document -- 🎨 Dark Theme: the `src/styles/theme.js` file contains a set of colors and default styles that are applied to components with Emotion. A default light and dark theme are already in the file -- 🔍 Search: full-text search of a user's entries stored in Firestore for quick access to past entries -- 🖥 Mobile Friendly: designed to look great on mobile as well as desktop, with easy navigation on both -- 💡 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 -- 🗄 Export: backup all of your entries at any time to save your data - ## Deploy To create an optimized build of the site run this command: From 73c3160a166ee51a8b6f5e082bba40be2d2c0fc4 Mon Sep 17 00:00:00 2001 From: gillkyle Date: Mon, 22 Apr 2019 23:20:44 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5e3114e..fe61fec 100644 --- a/README.md +++ b/README.md @@ -58,12 +58,16 @@ or yarn ``` -Then configure a file in a new `.env` file with the following keys from firebase: +Then configure a file in a new `.env` file (using the `.env.sample` file as a reference) with the following keys from the firebase console: ```env REACT_APP_FIREBASE_API_KEY= -REACT_APP_DEV_AUTH_DOMAIN= -REACT_APP_DEV_DATABASE_URL= -REACT_APP_DEV_PROJECT_ID= +REACT_APP_DEV_AUTH_DOMAIN=.firebaseapp.com +REACT_APP_DEV_DATABASE_URL=https://.firebaseio.com +REACT_APP_DEV_PROJECT_ID= +REACT_APP_DEV_STORAGE_BUCKET=.appspot.com +REACT_APP_DEV_MESSAGING_SENDER_ID=############ + +REACT_APP_CONFIRMATION_EMAIL_REDIRECT=https://.firebaseapp.com ``` Navigate into the project directory, and then launch the site with this command: