Frappoint

bench get-app https://github.com/navariltd/frappoint

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=navariltd%2Ffrappoint)](https://frappegems.com/gems/apps/navariltd/frappoint)

## Frappoint **Frappoint** is an appointment management system designed for service providers. It allows users to **manage appointments**, **providers**, and **associated services**. This system includes functionalities for **booking**, **confirming appointments**, **managing slots**, and **handling customer interactions**. ### Key Features - **Appointment Handling** - Robust system to manage service appointments, including status tracking (Open, Confirmed, Completed, etc.) - **Provider Management** - Manage providers with details such as names, contact information, and availability. - **Slot Management** - Create and manage appointment slots for providers, ensuring that appointments do not overlap. - **Customer Interaction** - Capture customer details and preferences, including options for video conferencing. - **Billing Integration** - Automatically generate and manage sales orders and invoices related to appointments. - **Google Calendar Integration** - Sync appointments with Google Calendar for easy management and reminders. - **Automated Notifications** - Send SMS confirmations for appointments, ensuring that customers are kept informed. ## Basic Usage ### Booking an Appointment 1. Navigate to the **Service Appointment** form. 2. Fill in required details including: - Customer Information - Appointment Provider - Appointment Date and Time 3. Confirm the appointment by saving or submitting the form. ### Checking Available Slots On the Service Appointment form, click the **Show Available Slots** button to view your options based on the **service type** and optionally **provider**, **appointment date**. ## Configuration - **Appointment Settings**: Adjust appointment settings such as default slot lengths and maximum advance booking days through the **Service Appointment Settings** document in ERPNext. - **Provider Shift Types**: Define shifts for providers detailing their working hours, breaks, and holiday schedules. ### Under the Hood - [**Frappe Framework**](https://github.com/frappe/frappe): A full-stack web application framework written in Python and Javascript. The framework provides a robust foundation for building web applications, including a database abstraction layer, user authentication, and a REST API. - [**Frappe UI**](https://github.com/frappe/frappe-ui): A Vue-based UI library, to provide a modern user interface. The Frappe UI library provides a variety of components that can be used to build single-page applications on top of the Frappe Framework. ## Production Setup ### Managed Hosting You can download the app from [Frappe Cloud](https://frappecloud.com), a simple, user-friendly and sophisticated [open-source](https://github.com/frappe/press) platform to host Frappe applications with peace of mind. It takes care of installation, setup, upgrades, monitoring, maintenance and support of your Frappe deployments. It is a fully featured developer platform with an ability to manage and control multiple Frappe deployments. ## Development Setup ### Manual Installation To setup the repository locally follow the steps mentioned below: 1. Setup bench by following the [Installation Steps](https://frappeframework.com/docs/user/en/installation) and start the server ``` bench start ``` 2. In a separate terminal window, run the following commands: ``` # Create a new site bench new-site test_site.com ``` 3. Get the Frappoint app and install it ``` # Get the Frappoint app bench get-app https://github.com/navariltd/frappoint # Install the app bench --site test_site.com install-app frappoint ``` 4. Open the URL `http://test_site:8000/app` in your browser, you should see the app running ## Learning 1. [Official documentation](https://docs.navari.co.ke/frappoint/introduction) ### Contributing This app uses `pre-commit` for code formatting and linting. Please [install pre-commit](https://pre-commit.com/#installation) and enable it for this repository: ```bash cd apps/frappoint pre-commit install ``` Pre-commit is configured to use the following tools for checking and formatting your code: - ruff - eslint - prettier - pyupgrade ### CI This app can use GitHub Actions for CI. The following workflows are configured: - CI: Installs this app and runs unit tests on every push to `develop` branch. - Linters: Runs [Frappe Semgrep Rules](https://github.com/frappe/semgrep-rules) and [pip-audit](https://pypi.org/project/pip-audit/) on every pull request. ### License agpl-3.0