Django Multitenant Boilerplate is a comprehensive Django project template designed to kickstart your development process for building multi-tenant web applications. It includes all the features from the original Minimal Boilerplate and introduces additional functionality for handling multiple tenants in your Django application.

• Django 3.2: The latest stable version of Django.
• Simple project structure: Provides a clean and organized project structure to help you start your development quickly.
• Customizable settings: Easily modify project settings to suit your specific needs.
• Database configuration: Pre-configured to use PostgreSQL by default, but you can easily switch to other databases like SQLite or MySQL.
• Environment variables: Uses the python-decouple library to manage environment variables for your local development and production deployment.
• Debug toolbar: Includes Django Debug Toolbar to assist with debugging during development.
• Multitenancy support: Built-in support for handling multiple tenants within the same Django application.

• Tenant model and schema: The boilerplate includes a Tenant model and sets up a separate schema for each tenant in the database. This allows you to isolate data between tenants securely.
• Tenant-specific settings: Provides the ability to have tenant-specific settings, enabling you to customize various aspects of your application for each tenant.
• Middleware for authentication: Includes middleware to handle tenant authentication and routing requests to the appropriate tenant's schema based on the URL or a custom header.
• Tenant management commands: Comes with management commands to create new tenants, set tenant-specific settings, and perform tenant-related tasks.

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

• Python 3.9 or higher
• pip (Python package installer)
• PostgreSQL

1. Clone the repository:

git clone https://github.com/azadhmhd/django_boilerplate_with_multitenant.git

2. Create a virtual environment and activate it:

python3 -m venv myenv
source myenv/bin/activate

3. Install the required Python packages:

pip install -r requirements.txt

4. Set up the environment variables:

• Rename the .env.sample file to .env.
• Open the .env file and provide the necessary values for the environment variables.

1. Migrations

• Apply the initial database migrations by running the following command:

python manage.py migrate

To run the Django development server, execute the following command:

python manage.py runserver

Once the server is running, you can access the application by visiting http://localhost:8000 in your web browser.

If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make the necessary changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request with a detailed description of your changes.

This project is licensed under the MIT License. Feel free to use and modify it according to your needs.

We would like to acknowledge the following resources and projects that inspired and helped in the development of this boilerplate:

• Django
• PostgreSQL
• Django_multitenant

If you have any questions or suggestions, feel free to contact us at [email protected]. We appreciate your feedback!

Feel free to customize and expand this README file to provide more detailed information about your Django Multitenant Boilerplate project.