SparkEventify

A Student Event Calendar App

---

Requirements

• Flutter SDK (Comes with Dart SDK)
• Java LTS
• Android Studio
• Visual Studio Community (For Development)

---

Installation

Flutter with Git

1. Go to Flutter Documentation to get started.
2. Choose the appropriate OS for installing Flutter.
3. Ensure you meet the system requirements to run Git commands, or if you have Git installed, proceed to the next step.
4. Download Flutter SDK for Windows and follow the steps.
5. Update your path: Go to Edit the system environment variables and set the PATH value to C://<path-to>/flutter/bin. See the documentation for instructions.
6. After updating the path, run flutter doctor in your terminal:

   flutter doctor

---

Project Setup

1. Clone this repository to your project directory using Github Desktop, or open your terminal and run:

   git clone https://github.com/ronhedwigzape/student_event_calendar.git

2. Navigate to the project directory:

   cd student_event_calendar

3. Install Visual Studio. Ensure Desktop Development with C++ is installed.
4. Install Google Chrome for completion in flutter doctor.
5. Install Android Studio. Open Android Studio and go to More Actions > SDK Manager > SDK Tools tab, and install Android SDK Command-line Tools (latest).

Creating an Android Emulator using Android Studio

1. Open Android Studio: Launch Android Studio and select "More Options" > "Virtual Device Manager".
2. Create a new Virtual Device: Click "Create Virtual Device", select a device (e.g., Pixel XL), and click "Next".
3. Download a System Image: Select a version of Android, click "Download" > "Accept" > "Next" > "Finish".
4. Configure the AVD: Set additional configuration details and a custom name for your emulator.
5. Launch the AVD: Select the virtual device from the dropdown menu at the top of Android Studio.

Running Android Emulator

1. Locate Android SDK: Default location is C:\Users\<your-user-name>\AppData\Local\Android\Sdk.

2. Set the ANDROID_HOME environment variable: Add C:\Users\<your-user-name>\AppData\Local\Android\Sdk\emulator to your PATH.

3. Set the JAVA_HOME environment variable: Add C:\Program Files\Java\jdk-17 to your PATH.

4. List and run emulators:

   emulator -list-avds
   emulator -avd <name-of-your-emulator>

   Example:

   emulator -avd Pixel_XL_API_33

5. Complete flutter doctor issues:

   flutter doctor --android-licenses

6. Expected output for flutter doctor:

   

7. If you have a device, enable Developer Options and USB debugging mode.

8. Install dependencies and start development:

   flutter run

9. If you encounter Current Dart SDK version not updated error:

   flutter channel beta
   flutter upgrade

10. To run on Chrome:

    flutter run -d chrome --web-renderer html

11. Change directory to /web and install dotenv package:

    cd /web
    npm install

---

Production Setup

Building and Releasing an Android App

1. Review the App Manifest: Check <app dir>/android/app/src/main and verify values.
2. Review the Build Configuration: Check <app dir>/android/app/build.gradle.
3. Build an App Bundle:

   flutter build appbundle

4. Test the App Bundle.
5. Publish to Google Play: Follow the Google Play launch documentation.

Building and Releasing an iOS App

1. Review the App Configuration: Open ios/Runner.xcworkspace in Xcode.
2. Select the Deployment Target: Specify the iOS version in Xcode.
3. Add an App Icon: Follow the App Icon guidelines.
4. Create a Build Archive: Select Product > Archive in Xcode.
5. Publish to the App Store: Follow the iOS App Store distribution guide.

Building and Releasing a Web App

1. Add Web Support:

   flutter channel stable
   flutter upgrade
   flutter config --enable-web

2. Build the App for Release:

   flutter build web

3. Serve the App:

   python -m http.server 8000

4. Deploy the App: Use Firebase Hosting or any web server.

---

Updating Dependencies

• Update dependencies:

  flutter pub upgrade

Cleaning Build

• Clean the build:

  flutter clean
  flutter pub get

---

Enjoy using SparkEventify!