Thoth1111 / Permit-Manager

A mobile application from which users can register their business permits/licenses and pay for extensions. The application has a sibling platform to be used by agents to validate physical copies of licenses and view a list of expired permits based on jurisdiction.

📗 Table of Contents

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

Permit Manager

This project is for a mobile application from which users can register their business permits/licenses and pay for extensions. Licenses are also updated and PDF versions made available for download upon payment/extension. The application has a sibling platform to be used by agents to validate physical copies of licenses and view a list of expired permits based on jurisdiction. It features a node.js backend and a mongoDB database.

The main features of the app are:

• User authentication using JWT(JSON Web Token).
• List of expired saved permits and those due to expire within 30 days or less.
• Separate view for all saved Licenses and completed payments.
• Digital License that is downloadable in PDF format and contains a QR code used to validate its existence and expiry date.
• Payment by stk push using Safaricom's Daraja API

🚀 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/Permit-Manager

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/Permit-Manager.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
• Alerts and SMS notifications
• Opt out & Account deletion features
• 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)