diff --git a/README.md b/README.md index 1326a09..01f9d91 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://app.bitrise.io/app/1777d1ca81df02fb/status.svg?token=JR4pw9Z3dElWNrDmy3ImLA&branch=master)](https://app.bitrise.io/app/1777d1ca81df02fb) -An amazing open source group messaging app build with flutter. ✨ +An amazing open-source group messaging app build with flutter. ✨ # Main Features @@ -10,10 +10,10 @@ An amazing open source group messaging app build with flutter. ✨ - Multiple *open or private* channels within groups. - Sharing of photos and photo collections. - React to messages with emoji. -- Push-notifications for message and channel updates. +- Push-notifications for the message and channel updates. - Specific channels for events (e.g. containing date, venue). - Editing of event channels. -- Calendar for all upcoming and passed events aggregated over all groups and channels. +- Calendar for all upcoming and past events aggregated over all groups and channels. - English and German localization. - RSVP for events. @@ -46,14 +46,14 @@ To build and run the mobile apps you’ll need to install [Flutter](https://flut $ flutter doctor ``` -The app is optimised for Android and iOS phones in portrait mode. +The app is optimized for Android and iOS phones in portrait mode. **Note:** Additionally you’ll need to add the GoogleService-Info of your Firebase app to your clients as described in `B3. Configure firebase app` below. ## Backend (Firebase) -The backend is build using Firebase’s `node.js` SDK. All files are provided in the `firebase` folder. To deploy the code create an app and install the firebase CLI (See step 1 & 2 in [Getting started](https://firebase.google.com/docs/functions/get-started)). +The backend is build using Firebase’s `node.js` SDK. All files are provided in the `firebase` folder. To deploy the code create an app and install the firebase CLI (See steps 1 & 2 in [Getting started](https://firebase.google.com/docs/functions/get-started)). *Note: The following steps assume you’re using Firebases’ free `Spark Plan`. Therefore we’re performing the configuration manually.* @@ -68,7 +68,7 @@ An initial sign-in method needs to be configured. **Adding a user** -Currently users need to be added *manually*. +Currently, users need to be added *manually*. - In firebase navigate to `Authentication` and select `Users`. - Then `Add user`. @@ -97,7 +97,7 @@ In the firebase console select `Database` under `Develop` and create a Cloud Fi | members | array | *User-UID we’ve retrieved in **Adding a user*** above | | name | string | test | -We’ve now setup our fist test group. In addition to this step we’ll need to setup a default `Channel` (e.g. something similar to `#general` in Slack). +We’ve now setup our fist test group. In addition to this step, we’ll need to setup a default `Channel` (e.g. something similar to `#general` in Slack). **Create channel sub-collection** @@ -114,7 +114,7 @@ We’ve now setup our fist test group. In addition to this step we’ll need to ### B3. Configure firebase app -Next you’ll need to configure your firebase app for Flutter as described in [Add Firebase to an App / Flutter](https://firebase.google.com/docs/flutter/setup) +Next, you’ll need to configure your firebase app for Flutter as described in [Add Firebase to an App / Flutter](https://firebase.google.com/docs/flutter/setup) **iOS** @@ -137,7 +137,7 @@ $ firebase deploy --only functions ### B5. Final steps -Run the flutter app using your favourite IDE (e.g. Visual Studio Code / Android Studio). Next you’ll need to run the app. +Run the flutter app using your favorite IDE (e.g. Visual Studio Code / Android Studio). Next, you’ll need to run the app. *Note: Please skip any error that might occur.* @@ -174,6 +174,6 @@ When building for release the app will automatically use the production configur # About The concept for Timy was created and developed by [kaalita](https://github.com/kaalita) and [philippmoeser](https://github.com/philippmoeser). -The the initial version is a MVP messaging app focusing on organising events among groups. +The initial version is a MVP messaging app focusing on organizing events among groups. We hope this project can be a reference or building block for your next flutter app. 🚀