ucleankim

Ucleankim is an open-source Flutter application designed to help admin manage and export data the school cleaning tasks.

Table of contents

• Getting Started
• System requirements
• Application structure
• Libraries and tools used
• Support

Getting Started

This section guides you through downloading, installing, and running the ucleankimAdmin application.

Prerequisites:

• Flutter: Download and install Flutter from the official website: https://docs.flutter.dev/get-started/install
• Code Editor: Choose your preferred code editor like Visual Studio Code (VS Code) or Android Studio.
• Version:Dart SDK Version 3.3.0 or greater. Flutter SDK Version 3.3.0 or greater.
• Steps:

1. Clone the Repository: Open your terminal and navigate to your desired project directory. Then, clone the ucleankimAdmin repository using the following command:

   git clone https://github.com/Ken-Andre/uclean_admin.git

2. Install Dependencies: Navigate to the project directory using the cd command in your terminal. Then, run the following command to install the required dependencies:

   flutter pub get

3. Run the App: Connect your device or start an emulator. Finally, run the application using the following command:

   flutter run

Additional Notes:

• Ensure your device or emulator is connected and configured properly with Flutter.
• Refer to the Flutter documentation for detailed setup instructions: https://docs.flutter.dev/get-started/install
• If you encounter any issues during installation or running the app, consult the project's troubleshooting guide (if available) or seek help from the Flutter community forums.

Application Structure

.
├── android                         - It contains files required to run the application on an Android platform.
├── assets                          - It contains all images and fonts of your application.
├── ios                             - It contains files required to run the application on an iOS platform.
├── lib                             - Most important folder in the application, used to write most of the Dart code..
    ├── main.dart                   - Starting point of the application
    ├── core
    │   ├── app_export.dart         - It contains commonly used file imports
    │   ├── constants               - It contains static constant class file
    │   └── utils                   - It contains common files and utilities of the application
    ├── presentation                - It contains widgets of the screens 
    ├── routes                      - It contains all the routes of the application
    └── theme                       - It contains app theme and decoration classes
    └── widgets                     - It contains all custom widget classes

Libraries and Tools Used

• BLoC - State management https://bloclibrary.dev
• cached_network_image - For storing internet image into cache https://pub.dev/packages/cached_network_image

Support

If you have any problems or questions, go to our Discord channel, where we will help you as quickly as possible: https://discord.gg/ccHnFFCYur

Contributions

See the contributions.md. If you want too to contribute, make a pull request and maintainers will see and make a decision.