1. Installation Screen

2. Server Requirements & Extensions

If PHP version is lower than 8.0 or any extension is not installed then it will be highlighted using Red color. So you need to make sure that your server meets the all requirement.

3. Permission Screen

Make sure this folder have read & write permissions. If not then assign this folders read & write permissions.

4. Database Configuration Screen

5. Database Connection Status

6. Final installation Screen

If everything is configured successfully then your Admin panel has been installed successfully.You can login as Super Admin using the credentials provided here.

After Installation you need to setup some settings before using the system.

1. Session Year

Set your Current & upcoming session years here, So you can manage studens by session year

2. App Settings

This settings will be used by your Flutter APP.

3. General Settings

This settings will be used by Admin Panel.You can set your current session year here.

4. FCM Server Key

FCM Server key will be used for APP notifications.

5. Email Configurations

Send Email configurations so that system can send emails to registered users.

6. Fee payment Configurations

Stripe credentials. At a time only one payment gateway will be enable

7. Payment Gateway's Webhook Configration

2. Webhook Configration for Stripe

Setup flutter in your system

Visit flutter official website : https://docs.flutter.dev/get-started/install for full install guide.

If you prefer video tutorials, we recommend this playlist for the full installation process
https://www.youtube.com/playlist?list=PLSzsOkUDsvdtl3Pw48-R8lcK2oYkk40cm

1. Unzip the downloaded code. After unzipping you will have e-School Saas - Flutter Code zip folder. Unzip that folder and open it in Android Studio or Visual Studio Code.
2. Open ide terminal go to your project path and execute command

   flutter pub get

3. If you are running this app for ios then run these following commands in terminal.

   cd ios

   pod install

   cd ..

4. Change package name of android app
   Execute this command in your terminal
   

   flutter pub run change_app_package_name:main your_new_package_name

   
   
   
   
5. Change package name of ios app
   Open ios folder of this project in xcode. Go Select Runner->Targets->General->Identity and enter new package name in Build Identifier.
   
   

1. Create firebase project in your account

   
   
   
   
   
   
   
   
   
   

2. Add andorid application to your firebase project

   
   
   
   
   

   Download the google-service.json file and add in this folder android/app/

   
   
   
   
   
   
   
   
   

3. Add ios application to your firebase project

   
   
   
   
   
   
   

4. Download GoogleService-Info.plist and add in this folder ios/Runner/

   
   
   
   
   

5. Please configre this settings in-order to send ios notifications.
   

   https://firebase.flutter.dev/docs/messaging/apple-integration
   
   

6. You have configured firebase in your project successfully

Go to lib/utils/constants.dart and replace the baseUrl with your admin panel url.

Add Logo Manually

For Android, open android > app > src > main > res and add here your logo according to device screen size

For IOS open ios > Runner > Assets.xcassets > AppIcon.appiconset here and add your logo according to diffrent size.

Generate Logo Files With Package

1. Add your logo file in assets/images folder

2. Add it's path and filename in pubspec.yaml file under flutter_launcher_icons configurations

3. Run this command to generate the ic_launcher files for both Android and IOS:

flutter pub run flutter_launcher_icons

For Android, go to android/app/src/main/AndroidManifest.xml and change the app name as shown in image. Replace the selected eschool text with your school name

For IOS open this project in xcode and enter your app name in display name field as shown in image.

Please setup java path in android/gradle.properties file as shown in the image.

Open your terminal, navigate to your project path and execute the following command to run this app.

flutter run

Go to README.md file to check all the commonly used commands to fix issues that you may encounter while running the app. You'll also be able to run the shell script directly if you're using Android Studio.

Go to lib/ui/styles/colors.dart and set your theme colors

1. Go to lib/app/app.dart and add your font as shown in image.

   
   
   
   
   

2. Go to assets/google_fonts/ and add .tff files of fonts.

   
   
   

1. By default,default applicaiton language is english. If you want to change default language go to lib/utils/appLanguages.dart and add your respective language's code shown in below image. Get your language code from here https://developers.google.com/admin-sdk/directory/v1/languages.

   
   
   
   
   

2. If your default language code is not in app language list add language details in list as shown in below image. Go to lib/utils/appLanguages.dart

   
   
   
   
   

3. If your default language is not in assets/languages/[language-code].json then create new file in same folder with [language-code].json. Add all the labels from en.json and convert label values in your respective language

   
   
   
   
   

4. Copy all the labels form en.json file in your [language-code].json file.

   
   
   
   
   

5. If you want to add new language then follow the steps 2,3 and 4.

In the lib/utils/constants.dart file, to enable/disable item appearing animations, you can change the value of isApplicationItemAnimationOn to true/false according to your requirements.

To change the duration of animation you can adjust the milliseconds of different animations by increasing/decreasing the values of the duration variables.

Create and add Key Store file for Androd:

1. To generate a keystore file, run the following command:

   
   keytool -genkey -v -keystore your-keystore-file.jks -keyalg RSA -keysize 2048 -validity 10000 -alias your-alias
   
   

   You can replace "your-keystore-file.jks" with your preferred filename, but ensure you keep the ".jks" extension. Similarly, you can change "your-alias" as needed, but make sure to remember it. During this process, you will be prompted to set a password; please note that the password characters won't be visible on the screen.
   
   Additional information may be requested, but you can simply press Enter to skip those as they are optional fields.

   
   
   

2. Create a file named "key.properties" in your project's "android" folder and add the following details, which correspond to the information you used in the previous step:

   
   storePassword=[your-password-from-previous-step]
   keyPassword=[your-password-from-previous-step]
   keyAlias=[your-alias-from-previous-step]
   storeFile=[your-keystore-file-location]
   
   
   

   Replace the placeholders ("[]" brackets) with the actual details you used. Once these two steps are completed, you can generate either an APK file using the following command:

   
   flutter build apk
   
   

   Or an app bundle file for the Play Store upload with:

   
   flutter build appbundle

Follow these links for more information on generateing the release version:

1. To generate release android app-bundle and publish to playstore follow https://flutter.dev/docs/deployment/android

   
   
   

2. To generate release ios apk and publish to appstore follow https://flutter.dev/docs/deployment/ios