SLNIC Decoder

About · Features · Inside · Installation · Compilation · Development

About

This is a flutter app to decode the Sri Lankan NIC (National Identity Card) number, developed as the final project for the CCS3351 Mobile Application Development module of University.

Features

1. Extracts serial number of the ID, Date of birth, weekday of the birthdate, age, gender and person's ability to vote
2. Material 3 design
3. Dynamic dark/light theme support

Inside

Architecture

This a very high-level abstraction of the main business logic of the application.

Design

• Material 3 - The app follows the Material 3 design guidelines
• Custom Icons - Custom icons are used for the app logo and the launcher icon
• Brand Icons - Brand icons are taken from the simpleicons.org
• Colors - The app uses a custom color palette inspired by Catppuccin mocha theme

Wireframe and design files are available through Figma.

Technologies

1. GetX for State Management
2. Url_launcher for launching web links
3. Flutter launcher icons for generating launcher icons
4. Flutter test and mockito for testing
5. Dart doc for api documentation
6. GitHub actions for CI/CD

Folder Structure

1. .github - Contains the github actions workflow files
2. assets - Contains the app launcher icon and other assets
3. docs - Contains the auto-generated dart doc
4. lib - Contains all the code for the application
   • model - Contains the data model for the NIC with the decoding logic
   • controllers - Contains the GetX controllers for NIC decoding and Navigation
   • screens - Contains the UI screens
   • main.dart - Entry point of the app
5. test - Contains all the test files
   • controllers - Contains the tests for the GetX controllers

Widget Tree

Flutter outline and abstracted widget tree can be viewed from here.

API documentaion

Docs are generated from dart doc, deployed with GitHub Pages and can be viewed from here.

Installation

1. Grab the latest apk installer from releases.
   • Choose the arm64-v8a version for most of the modern devices. (2016 and above)
   • Choose the armabi-v7a version for older devices.
2. Enable apk sideloading on your device.
3. Open up the nic-app-v.x.x.x.apk file and follow the instructions.

Note

As of now, installation packages are only available for android devices. If you wish to use this app on an iOS device, you will have to compile it from source. See compilation for more information.

Compilation

Prerequisites

1. Flutter SDK 3.6.0 or above
2. Android studio latest

Steps

1. Clone the repository and change to the directory:

git clone https://github.com/Chamal1120/flutter_nic_decoder.git
cd flutter_nic_decoder

2. Sync the packages:

flutter pub get

3. Compile for your device:

flutter build apk --release # For android
flutter build ios --release # For ios

Development

Prerequisites

1. Flutter SDK 3.6.0 or above
2. Android Studio latest
3. Code editor that supports Flutter Development (VSCode, Android Studio, Neovim, etc.)
4. Emulator configured through Android studio or AVD Manager (or a physical device)

Steps

1. Follow step 1 and 2 from compilation section.
2. Run the emulator or connect your physical device:

flutter devices # To list all the devices
flutter emulators --launch <emulator_name> # To launch an emulator

3. Run the app in debug mode:

flutter run

4. Open up lib folder (where most of the code lives) and start developing.

Warning

This is an unlicensed project, as i'm doing it for an assignment in one of my University modules. I might later add an MIT license after when asignment has graded so anyone can use this for whatever purposes.

Thank You

You're a cool human being if you read it up to here.