Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ketanchoyal/Our-E-School

A mobile app created using Flutter Framework for School management.
https://github.com/ketanchoyal/Our-E-School

android-application database firebase-firestore firebase-functions firestore flutter flutter-apps flutter-examples flutter-web flutter-web-example ios-app mvvm-architecture provider-architecture school school-management typescript

Last synced: 3 months ago
JSON representation

A mobile app created using Flutter Framework for School management.

Awesome Lists containing this project

README 

        
# Our E School 



## This Project has been Archived as I'm no longer working on it



NOTE TO NEW CLONERS: (READ THIS BEFORE USING OR CREATING AN ISSUE)

        || This Project is not migrated to null-safety yet

        || This project was built with Flutter versions less than 2.0 (flutter V 1.X)

        || Before compiling this project you have to make sure you update server.dart file to include the firebase functions URL's (this is a must procedure)

        || initialize your firebase firestore project as instructed in database folder on this project.

        

        



## This Project is not migrated to null-safety yet

#### So if you're trying to run it then you might need to downgrade your flutter version.

#### You can use [fvm](https://github.com/leoafarias/fvm) if you do not want to downgrade your flutter version.



 [![HitCount](http://hits.dwyl.com/ketanchoyal/Our-E-School.svg)](http://hits.dwyl.com/ketanchoyal/Our-E-School)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/ketanchoyal/Our-E-School/pull/new/master)

[![GitHub stars](https://img.shields.io/github/stars/ketanchoyal/Our-E-School.svg?style=social&label=Stars✯)](https://github.com/ketanchoyal/Our-E-School/stargazers/)

## I open sourced this project because I wasn't got paid



## PR's are always welcomed



### An open source project for school management



### State Management: [Provider](https://pub.dev/packages/provider) + [Get_it](https://pub.dev/packages/get_it)



### MVVM(Model-View-(View)Model) Architecture



### Note: This app is not fully developed, it still has a lot of bugs and I'm still working on it (For now all the login data for parent, teacher and student are added manually in firestore)



### [Web Portal](https://github.com/ketanchoyal/Our-E-School-Web-Portal) is under development.



#### There are backend firebase functions too written in Typescript for some automation and some functions to make them work with web based project(future proof)



Our E School is the app build for iOS and Android using Flutter.



It uses Firebase FireStore as Database and Firebase Storage.



## FeatureS



|  UI  | Logic | Feature |

| ------ | ------ | ------|

| ✔ | ✔ | Teacher Login

| ✔ | ✔ | Student Login

| ✔ | ✔ | Parent Login

| ✔ | ✔ | Multiple Child Profile View

| ✔ | ✔ | Chat between teacher and parent

| ✔ | ✔ | Intro Screens.

| ✔ | ✔ | Post photo or notice on Standard post section(Only Teacher)

| ✔ | ✔ | Post photo or notice on global post section(Only Teacher)

| ✔ | ✔ | Dark Mode

| ✔ | ✔ | Profile Setup

| ✔ | ✔ | Forget Password

| ✔ |  | TimeTable

### and many more......



## Screenshots









## Database



Database structure snapshot are [here](https://github.com/ketanchoyal/Academic-Connect/raw/master/DB%20Structure).



A full database documentation will be created soon..



## Server.dart 



You need to create this and put in /core/ folder. \

This File is necessary in order to make Cloud Functions work.



```dart

class Server {

  static String baseUrl =

      YOUR-CLOUD-FUNCTION-URL;

  static String webApi = 'webApi/';

  static String profileUpdate = 'profileupdate';

  static String getProfileData = 'userdata';

  static String postAnnouncement = 'postAnnouncement';

  static String addAssignment = 'addAssignment';

}

```



## Getting Started



This project is a starting point for a Flutter application.



A few resources to get you started if this is your first Flutter project:



- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)

- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)



For help getting started with Flutter, view our 

[online documentation](https://flutter.dev/docs), which offers tutorials, 

samples, guidance on mobile development, and a full API reference.