Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/veeeetzzzz/pest-control-booking-system

A Pest Control booking system that utilises Azure AD for authentication
https://github.com/veeeetzzzz/pest-control-booking-system

Last synced: about 2 months ago
JSON representation

A Pest Control booking system that utilises Azure AD for authentication

Awesome Lists containing this project

README

        

# Pest Control Booking System

Note:

This is work-in-progress/being built in public.

This repository should not be considered a suitable branch for production, it is subject to experimentation and all commits are being submitted with a build-in-public approach.

A Pest Control booking system that utilises Azure AD for authentication and allows managers to assign jobs and operatives to see details/act on appointments. Includes integration for external reporting tools like PowerBI as well as built in reporting tools for ad hoc queries. Also supports various payment processors and you can set up custom API end points for other applications to consume the data from this application.

# Current issues/WIP

- Navbar w/ integration to MS Graph API to access profile picture etc.
- Login layout refinment (rework Tailwind CSS stylesheets)

# Concept

## Dashboard - Manager View

![Screenshot 2024-01-29 at 19-06-31 ### Manager Dashboard - Pest Control Booking System](https://github.com/Veeeetzzzz/pest-control-booking-system/assets/40268197/893bd7db-a317-490e-84ef-c78530294817)

## Bookings - Manager View

![image](https://github.com/Veeeetzzzz/pest-control-booking-system/assets/40268197/7a2b4deb-c676-4b39-b166-08c8958858db)

## Customers - Manager View

![A Customers](https://github.com/Veeeetzzzz/pest-control-booking-system/assets/40268197/6a4f9280-1402-4f9d-b0ac-a9fceeb1bc79)

## Technicians - Manager View

![B Technicians](https://github.com/Veeeetzzzz/pest-control-booking-system/assets/40268197/d563c990-bd49-4b50-8533-f1dbca6f6341)

## Reports - Manager View

![C Reports](https://github.com/Veeeetzzzz/pest-control-booking-system/assets/40268197/73c7d451-69d7-40e2-b03b-e2bd43fafbac)

# Features

- PowerBI integration
- Standalone reporting
- Payment processing integration
- Azure Active Directory Single Sign On
- Custom API endpoints for your data to integrate into other applications such as Dynamics 365 CRM

# Prequisites

- Backend: MongoDB
- Frontend: Node.js
- Azure AD Application for AD SSO
- Azure/Vercel.

# Installation

Step 1: Clone the GitHub Repository

git clone https://github.com/Veeeetzzzz/pest-control-booking-system

Step 2: Install Node.js and npm

Ensure Node.js and npm (Node Package Manager) are installed on your machine. If not, download and install them from Node.js official website.

Step 3: Install Project Dependencies

Navigate to your project directory (where your project was cloned) and run:

npm install

This command will install all the dependencies listed in your package.json file.

Step 4: Update Configuration Files

Open the authConfig.js file in your project.

Replace the placeholders in msalConfig with your actual Azure AD application details:

clientId: Your Azure AD application client ID.

authority: Your Azure AD authority URL, usually in the format https://login.microsoftonline.com/.

redirectUri: The URI where Azure AD will redirect to after authentication. It should match what's configured in your Azure AD application.

Step 5: Run the Application

In the project directory, run:

npm start

This command will start the React application. By default, it should be accessible at http://localhost:3000.

Step 6: Deployment (Optional)

For deployment, you can use various services like Vercel, Netlify, or Azure Static Web Apps.

Each platform has its own set of instructions for deployment. Generally, you'll need to connect your GitHub repository and configure build settings.

Don't forget to update the redirectUri in your Azure AD application and authConfig.js to match your deployed application URL.

# Additional Notes:
Always ensure that your redirectUri in the Azure AD application settings matches the URI in your authConfig.js and the actual URL where your application is running or deployed.

Keep your clientId and other sensitive information secure. Avoid pushing these details to public repositories.

TBC
# License
License Agreement

1. Definitions

"The Software": All files avalible at this repositry https://github.com/Veeeetzzzz/pest-control-booking-system

"Commercial Use": Use of the Software in a commercial enterprise or for commercial purposes.

"Licensee": The individual or entity that uses the Software.

3. Grant of License

This Agreement grants the Licensee a non-exclusive, non-transferable, limited license to use the Software according to the terms set forth herein.

4. Use of the Software

The Software is provided for personal, non-commercial use only.
Any Commercial Use of the Software is strictly prohibited unless Licensee obtains a separate written agreement with the Licensor.

6. Restrictions

The Licensee shall not sublicense, or sell copies of the Software.

7. Contributions

Any contributions made to the Software by the Licensee shall be governed under the same terms and conditions of this Agreement.

8. No Warranty

The Software is provided 'as is', without warranty of any kind, express or implied.

9. Limitation of Liability

In no event shall the Licensor be liable for any claim, damages, or other liability arising from the use or inability to use the Software.