https://github.com/thoth1111/clm-server
A node.js server for two mobile applications created for municipalities to implement a platform for the management and enforcement of business licenses/permits.
https://github.com/thoth1111/clm-server
mongodb-atlas node-js
Last synced: 6 months ago
JSON representation
A node.js server for two mobile applications created for municipalities to implement a platform for the management and enforcement of business licenses/permits.
- Host: GitHub
- URL: https://github.com/thoth1111/clm-server
- Owner: Thoth1111
- License: mit
- Created: 2024-03-22T13:03:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T16:15:25.000Z (over 1 year ago)
- Last Synced: 2025-04-10T00:15:33.175Z (over 1 year ago)
- Topics: mongodb-atlas, node-js
- Language: JavaScript
- Homepage: https://www.loom.com/share/ea16cb1a5a1c49cc927b5b615f4f3cc9?sid=daeaf47f-991a-4ff5-bae5-cd9ec423d7dc
- Size: 144 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [CLM Server](#about-project)
- [🚀 Live Demo](#live-demo)
- [📄\[Project Documentation\] ](#project-documentation)
- [🛠 Built With ](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing ](#contributing)
- [⭐️ Show your support ](#️support)
- [🙏 Acknowledgments ](#acknowledgements)
- [📝 License ](#license)
This project is for a node.js server for two mobile applications i.e [Permit Manager](https://github.com/Thoth1111/Permit-Manager) and [CLM Agent Portal](https://github.com/Thoth1111/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.
- [Click here for live demo](https://www.loom.com/share/ea16cb1a5a1c49cc927b5b615f4f3cc9?sid=daeaf47f-991a-4ff5-bae5-cd9ec423d7dc) of the application from the frontend user interfaces.
- GitHub repository [link](https://github.com/Thoth1111/CLM-Server)👈
- Programming Languages: JavaScript.
- Database: MongoDB
- Version-Control: Github
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 `` 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.
👤 **Alwyn Androvelle**
- Github: [@Thoth1111](https://github.com/Thoth1111)
- Twitter: [@androvelle](https://twitter.com/androvelle)
- LinkedIn: [@Alwyn](https://linkedin.com/in/alwyn-androvelle-simiyu)
## 🔭 Future Features
- [] **Complete payment stk-push transactions in production**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Thoth1111/CLM-Server/issues).
Give a ⭐️ if you like this project!
This project is [MIT](./LICENSE) licensed.