Welcome to the future of identification! The OpenKYC Community Project allows you to create your own electronic Know Your Customer (eKYC) solution. With its seamless integration and robust features, you can contribute to the project and enhance your application. Whether you’re a developer or just interested in what this project offers, this guide will help you navigate through it.

Before We Get Started

• This app currently supports only the Android platform (arm64).
• You will need a new AAR library if you are creating this app on your own or changing the package name.
• When viewing code in an editor, hover over functions or classes for additional information.
• We are enhancing the codebase and may have some legacy code; stay tuned for improvements!
• Installing Flutter and Dart extensions in your code editor will enhance your development experience.
• Generate your Google Maps API key and Firebase account if you’re developing this independently.
• For any issues faced, feel free to contact us here.

Getting Started

Follow these steps to kick-start your eKYC application journey:

1. Step 0: Install Flutter and Android Studio.
2. Step 1: Clone the project to your local device using this link: Clone the Project.
3. Step 2: To change the package name, run the command: flutter pub run change_app_package_name:main com.new.package.name. Remember to generate a new AAR.
4. Step 3: For renaming, navigate to android/app/src/main/AndroidManifest.xml and update android:label="yourappName".
5. Step 4: To build an APK, run: flutter build apk --split-per-abi. It’s important to note that if you changed the package name, this command will generate an APK, but it won’t work directly.
6. Step 5: Get your Google Maps SDK key from Google API (if using location-based verification). Follow the steps to create credentials and add your API key in android/app/src/main/AndroidManifest.xml.
7. Step 6: Open a Firebase account and create a project. Add an Android App with the package name, download the config file googles-services.json, and place it in the root directory. Ensure that you create the required collections and enable email/password login.
8. Step 7: Connect an emulator or device and use the run button on the main.dart file or run flutter run in your terminal.
9. Step 8: After setup, copy the code from firestore.rules to your Firestore security rules.

Understanding the Code: An Analogy

Imagine building a house. Each step in development corresponds to laying the foundational elements of the home. Just as you need bricks, cement, and steel to build structurally sound walls, you need specific libraries, package names, and Firebase configurations to create a robust app. When you change the package name, it’s akin to remodeling your home — you’ll need to update the address, ensure everything meets code, and then inspect it again to ensure the structure complies with the new layout. Each coding step is crucial; miss one, and the whole project could tumble like a poorly built house!

Common Errors and Troubleshooting

Like any journey, there can be bumps along the way. Here are some common errors you may encounter:

• Error 1: If you see red lines or problems in the debug tab, simply run flutter pub get. This usually resolves issues stemming from missing references.
• Error 2: If you encounter an “init SDK” error, uninstalling and reinstalling the app can often fix this.
• Error 3: Should you face odd plugin errors, reset the plugin cache with flutter clean && flutter pub get.

If the problems persist, do not hesitate to contact us with your issue details.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Features of the eKYC App

• Effortless attendance management
• Face verification for attendance tracking
• Fast face verification process
• Static device usage to verify multiple individuals
• Add members without needing another app on their smartphone
• Multiple spaces with separate attendance tracking
• Attendance filtering and holiday changes
• Dark mode support
• Member and admin login functionalities
• Member addition via QR code
• Space joining through QR code
• Face login feature (Coming Soon)
• Daily logs and notifications (Can be added with cloud functions)
• Range selection for spaces (Admin Side)
• Geolocation-based verification (Coming Soon)
• More features on the horizon!

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.

Thank you for exploring the OpenKYC Community Project with us. We’re excited to see your contributions and advancements in this domain!