​
Overview

The Booking Plugin adds event scheduling & booking to your Django platform. It includes both admin-side configuration & scheduling pages, and customer-facing calendar and history pages. This quickstart guide will walk you through the process of setting up your booking environment and getting started with the Booking Plugin.

​
Setup

​
Prerequisites

Before you begin, make sure you have installed the Ruoom Core open source repository following its quickstart guide. While the Payment Plugin is not a strict prerequisite for the Booking Plugin, it is recommended to use it for handling payments. If desired, install the Payment Plugin following its quickstart guide.

​
Step-by-Step Instructions

  1. Download the Repository
After purchasing the repository from Ruoom Code Lab, download the source code package provided. You are also welcome to reach out to us at support@ruoomsoftware.com to request GitHub access to the plugin repositories if you have purchased them. This access enables you to clone the repositories and contribute back to the project through pull requests, fostering community collaboration and improvement.
  1. Install the Plugin
Next, place the downloaded repository code into the plugins folder within your Ruoom Core project. Then, add plugins.booking to the INSTALLED_APPS list in your settings.py file to ensure the Booking Plugin is recognized by the Ruoom Core framework.
  1. Run Migrations
After installing the plugin, run the following command to apply the necessary database migrations: 
python manage.py migrate
This step ensures that all database tables required by the Booking Plugin are created and ready for use.
  1. Collect Static Files
You may need to cache the static files for plugin files to be rendered correctly. Run the following command: 
python manage.py collectstatic
  1. Run the Development Server
Start the local development server to see the Booking Plugin in action. 
python manage.py runserver
Upon logging in, you should see the new buttons on the “Schedule” page for scheduling your new booking events - indicating successful installation.
  1. Schedule a Service
Navigate to the “Schedule” page to start adding and configuring your booking events. You will first have to create a Service Type, and then schedule a Service for that type.

​
Next Steps

  • Explore the various features available in the Booking Plugin.
  • Contribute to the project by submitting issues or pull requests on GitHub.
For more detailed instructions, refer to the README file in the Digital Products Plugin repository.