📗 Table of Contents

• 📗 Table of Contents
• CLM-Agent-Portal
  • 🚀 Live Demo
  • 📄[Project Documentation]
  • 🛠 Built With
  • Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

CLM Agent Portal

This project is for a mobile application from which municipality agents can validate physical copies of business licenses/permits and view a list of expired permits/licenses based on jurisdiction. The application has a sibling platform in which business owners can register their business permits/licenses and pay for extensions. It features a node.js backend and a mongoDB database.

The main features of the app are:

• Agent authentication for login alone using JWT(JSON Web Token).
• List of expired permits and those due to expire within 30 days or less within the jurisdiction given to the agent in session.
• Digital License view that displays crucial details of a business license/permit.
• An in-app scanner to scan the QR codes on physical copies of business licenses/permits and validate them.

🚀 Live Demo

• Click here for live demo

Project Documentation 📄

• GitHub repository link👈

Built With 🛠️

• Programming Languages: JavaScript.
• Frameworks: React-native.
• Database: MongoDB
• Version-Control: Github

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• React, React-native & expo.
• An android device with the expo app installed or an emulator such as Android Studio.
• A code editor such as VS code.

Setup

Get the code url by clicking <code> in the repository or use the link by provided below.

https://github.com/Thoth1111/CLM-Agent-Portal

Open the code editor and clone the repo. Alternatively, run the following command in the directory you wish to clone the application to.

$ git clone https://github.com/Thoth1111/CLM-Agent-Portal.git

Install

In the root directory, open the terminal and run this command.

npm i

or

npm install

Run locally

Run the following command:

npm expo start

If using an emulator, such as Android Studio, connect & run the virtual device. Press a to run the application in the virtual device.

If using expo in an android device, open the expo app and scan the QR code from the terminal to run the app in the device.

Run tests

(back to top)

Authors

👤 Alwyn Androvelle

• Github: @Thoth1111
• Twitter: @androvelle
• LinkedIn: @Alwyn

(back to top)

🔭 Future Features

• Two factor authentication
• Pagination of lists
• Scalability features
• Testing
• Reset & Forgot Password actions

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

📝 License

This project is MIT licensed.

(back to top)