📗 Table of Contents

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

CLM Server

This project is for a node.js server for two mobile applications i.e Permit Manager and CLM Agent Portal created for municipalities to implement a platform for the management and enforcement of business licenses/permits. It runs with a MongoDB database and React-native for the frontend applications.

🚀 Live Demo

• Click here for live demo of the application from the frontend user interfaces.

Project Documentation 📄

• GitHub repository link👈

Built With 🛠️

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

Getting Started

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

Prerequisites

• Postman or other API testing platforms, code editor extensions or applications.
• 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-Server

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-Server.git

Install

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

npm i

or

npm install

Run locally

Run the following command:

node server.js

Run tests

Open API testing tool such as postman and run the various calls from the test_requests directory.

(back to top)

Authors

👤 Alwyn Androvelle

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

(back to top)

🔭 Future Features

• [] Complete payment stk-push transactions in production

🤝 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)