angeldollface / ceramic

A small Vue.js 3 app to validate IMEI numbers. :lock: :rocket:

CERAMIC 🔒 🚀

A small Vue.js 3 app to validate IMEI numbers. 🔒 🚀

ABOUT 📚

Since I was trying to figure out the algorithm for validating IMEI numbers for a uni course, I thought I'd write a small app that solves this interesting problem. This little app checks whether the IMEI number of any one of your devices is valid or not by computing the check digit and comparing this to the actual check digit. The "Luhn Algorithm" is used to do this. A link to the library it uses in the background can be found in the section below.

LINKS 🌎

• Library implementation in ECMA Script: VIEW
• Library implementation in Rust: VIEW
• Web app implementation in Yew.rs: VIEW

DEPLOYED PROJECT ON GITHUB PAGES 🚀

To view a live deployed version of this project, click here: VIEW

USAGE 🔨

• 1.) Visit this link.
• 2.) Get the IMEI for your device from the instructions for your platform. (You might have to scroll a bit.)
• 3.) Copy this IMEI number or write it down.
• 4.) Put the number into the input field.
• 5.) Click "VALIDATE"!
• 6.) Receive the status of your IMEI number from the text below the "VALIDATE" button that says IMEI valid: Enter an IMEI number!.

Note: You can use this fake IMEI for testing: 356728113476259

QUALITY ASSURANCE ✅

I've tested this using the IMEI number of my iPhone and some IMEIs I found online.

TECHNOLOGIES USED 💻

• Vue.js 3
• Typescript
• Git

LUHN ALGORITHM IMPLEMENTATION ⚙️

The implementation of the Luhn Algorithm, the algorithm that actually validates IMEI numbers against their check digit, can be found in the file src/components/lib.ts.

TRY THE CODE FOR YOURSELF! 📥

Make sure you have the following tools installed and available from the command line:

• Node.js
• Git

Once you have these tools installed, execute these steps:

• 1.) Get the source code:

$ git clone https://github.com/angeldollface/ceramic

• 2.) Change directory into the source's root directory:

$ cd ceramic

• 3.) Install the project's dependencies:

$ npm install

• 4.) Run Vue's development server:

$ npm run serve

• 5.) Optional: To compile this project, run this command:

$ npm run build

CHANGELOG ✒️

Version 1.0.0

• Initial release.
• Upload to GitHub.
• Deployment on GitHub Pages.

Version 1.1.0

• Added a footer.
• Updated documentation.
• Added input validation.
• Added usage instructions.
• Added an info section on IMEIs.

NOTE 📜

• Ceramic 🔒 🚀 by Alexander Abraham 🖤 a.k.a. "Angel Dollface" 🎎 🎀
• Licensed under the MIT license.