diff --git a/README.md b/README.md index 1eacc8d4..491f22ee 100644 --- a/README.md +++ b/README.md @@ -1,119 +1,10 @@ -## Unity - Flutter Application +

-Unity is cross-platform Leave Management application written in dart using Flutter. +# Unity, Leave & Employee Management - Smarter HR Solution! -## Download App - - - -## Features -* Unity is open source leave management app designed to track employee's leave within an organization. -* Unity allows you to create and manage multiple spaces. -* You can easily add employees with different role types such as Admin, HR and Employee. - -:boom: Unity app uses `firestore` database. :boom: - -## Getting started -* Project setup instructions - -#### 1. [Flutter Environment Setup](https://docs.flutter.dev/get-started/install) -> **Note**: Flutter sdk vesion `3.3.7` is recommended to run project. - -#### 2. Clone the repo -```sh -$ git clone https://github.com/canopas/canopas-unity.git -``` -#### 3. Rename the app Package Name -* Rename the app package name (because this can affect the firebase). -* You can do it manually or using this package [Rename Package](https://pub.dev/packages/rename) or look at this [Stackoverflow Question](https://stackoverflow.com/questions/51534616/how-to-change-package-name-in-flutter). - -#### 4. Setup the firebase app -* You'll need to create a Firebase instance. Follow the instructions at https://console.firebase.google.com. - -#### 5. Enable Google Authentication -* Go to Firebase console for your new instance. -* Click "Authentication" in the left-hand menu. -* Click the "sign-in method" tab. -* Click the "Google" and enable it. - -#### 6. Enable the Firebase Database -* Go to the Firebase Console. -* Click "Firestore Database" in the left-hand menu. -* Click the "Create Database" button. -* It will prompt you to set up, rules, for the sake of simplicity, let us choose test mode, for now. -* On the next screen, select any of the locations you prefer. +Welcome to Unity, your all-in-one solution for seamless leave and employee management within your organizations! -#### 7.Add Flutter App in Firebase -* In the Firebase console, in the settings of your project. -* Click on the Flutter Icon to add Flutter app. -* Follow the instruction to add Flutter app. +---- Cover image---- - Screenshot 2020-05-04 at 6 01 40 PM - -* It will create `firebase_options.dart` file in the `lib` folder. - -#### 8. Get Google ClientId for app -* Go to [Google APIs console](https://console.cloud.google.com/apis/). -* On the top bar, Choose your project from drop down menu if selected default project is not your current project. -* Click on the "API APIs and services". - - Screenshot 2020-05-04 at 6 01 40 PM - -* On the left side menu, Select "Credentials". -* Click on the "Web client(auto created by Google Service)". -* Copy **"Client Id"** and **"Client Secret"** (We will use in next step). - -#### 9. Create Local file -* Add a new dart file named `desktop_credentials` in the `lib` folder. -* Add the below Code in the file. -``` -const String googleClientId = - "YOUR_GOOGLE_CLIENT_ID"; - const String authClientSecret = "YOUR AUTH_CLIENT_SECRET"; -``` - -#### * Run app on Android -* Run the following command from the project folder to get your SHA-1 key: - -``` -keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android -``` - -* Open Android app within your Firebase console. -* Add your SHA-1 key by clicking "Add Fingerprint". -* Download google-services.json. -* Replace it with old `google_services.json` in `android/app/` (You can also do it by Flutterfire CLI). - -#### * Run app on iOS -* Open XCode, right click the Runner folder, select the "Add Files to 'Runner'" menu, and select the GoogleService-Info.plist file to add it to /ios/Runner in XCode. -* Open /ios/Runner/Info.plist in a text editor. -* Then add the CFBundleURLTypes attributes. -``` -CFBundleURLTypes - - - CFBundleTypeRole - Editor - CFBundleURLSchemes - - - - com.googleusercontent.apps.861823949799-vc35cprkp249096uujjn0vvnmcvjppkn - - - -``` -* When running the app on the simulator for the first time, it may take a longer time to build. - -#### * Run app on web -* Open the "Credentials" page of the [Google APIs console](https://console.cloud.google.com/apis/). -* Click on the `Web client (auto created by Google Service)`. -* Copy the `Client ID` located at the top left side of the page. -* Open web/index.html file, add the following meta tag. -``` - - -``` -* Add localhost entries if you are running app on specific port on `Authorized JavaScript origins` or use the port that already specified in this field. -* Run `flutter run -d chrome --web-hostname localhost --web-port 7357`. -* Replace the port with one you added to the `Authorized JavaScript origins` fields. +## Download App + \ No newline at end of file diff --git a/cta/app-store.jpeg b/cta/app-store.jpeg new file mode 100644 index 00000000..637baa35 Binary files /dev/null and b/cta/app-store.jpeg differ diff --git a/cta/cta_banner.png b/cta/cta_banner.png new file mode 100644 index 00000000..190c682a Binary files /dev/null and b/cta/cta_banner.png differ diff --git a/cta/cta_btn.png b/cta/cta_btn.png new file mode 100644 index 00000000..48578f9d Binary files /dev/null and b/cta/cta_btn.png differ diff --git a/cta/play_store.png b/cta/play_store.png new file mode 100644 index 00000000..131f3aca Binary files /dev/null and b/cta/play_store.png differ