Warning

The current used version of Python in the Vercel platform is 3.9, this project uses Django 5.x, which is not compatible. Sadly, the page will remain offline until there.

Note

I'll rebuild some of the applications, because I want to implement some concepts that I've learned in the last few months and others that I want to understand better (this includes the use of an Event-Driven Architecture)

Default Project - Modular Components

Welcome to the Default Project, a versatile enterprise solution comprising various modules designed to meet the needs of a wide range of businesses. These modules are crafted to be generic and adaptable, ensuring compatibility with diverse projects across different industries.

Overview

This project aims to provide a foundation for building enterprise applications by offering a collection of essential modules. These modules are designed to be flexible and customizable, allowing developers to tailor them to specific business requirements without encountering legal constraints or proprietary limitations.

Key Features

Modularity: The project is structured into distinct modules, each addressing a specific aspect of enterprise functionality. This modular design promotes flexibility and scalability, enabling developers to easily add, remove, or modify modules as needed.
Customizability: The modules are designed to be highly customizable, allowing developers to adjust them to suit the unique requirements of their projects. Whether it's fine-tuning configurations or extending functionality, the project provides ample flexibility for customization.
Interoperability: The modules are built to seamlessly integrate with existing systems and technologies, facilitating smooth interoperability with other software components. This interoperability ensures compatibility with a wide range of platforms and frameworks, enhancing the project's versatility and usability.

Usage

To incorporate the Default Project modules into your enterprise application, simply follow these steps:

Module Selection: Identify the modules that align with your project requirements. Choose from a diverse range of modules covering areas such as authentication, data management, reporting, and more.
Integration: Integrate the selected modules into your project by importing them into your codebase. Follow the provided documentation and guidelines to ensure smooth integration and compatibility.
Customization: Customize the modules as needed to tailor them to your project's specific needs. Adjust configurations, modify functionalities, or extend features to align with your business requirements.
Testing and Deployment: Thoroughly test the integrated modules to ensure proper functionality and compatibility. Once testing is complete, deploy your enterprise application with confidence, knowing that it's built on a solid foundation of versatile and adaptable modules.

Deploying on Development

Menus and Submenus: the core application has some base templates, some of them are components for the areas on the view. The sidenav has the possibility to create static of dynamic fields (based on user, groups and subgroups permissions). As threy're orm models they needed to be created after the django migration process.

Dummy objects: the core application has an endpoint named create_objects which is responsible for creating the elements required by some queryes. The only purpose is to exemplify the app usage.

Run (with the python env), use the credentials for the admin superuser:

python manage.py makemigrations
python manage.py createsuperuser
python manage.py makemigrations warehoure
python manage.py migrate

Go to:

localhost/create-objects/

[!INFO] There's a small issue when running the create-objects endpoint multiple times, which is that there's some IntegrityError at /create-objects/: UNIQUE constraint failed: auth_group.name but I'll fix that later.

Deploying on Production

I need to improve the logic for the container to be able to run on production, in the moment it`s only running on development mode.

# Use an official Python runtime as a parent image
FROM python:3.7-slim

# Set environment variable
ENV ENV_ROLE production

# Other Dockerfile instructions...

version: '3'
services:
    web:
        build: .
        environment:
            - ENV_ROLE=production
        # Other service configuration...

Legal Notice

This project is provided under an open-source license, which grants users the freedom to use, modify, and distribute the code without restrictions. However, it's important to note that while the project itself is open-source, certain modules may incorporate third-party dependencies or libraries subject to their respective licenses. Users are advised to review and comply with the licensing terms of any third-party components used in conjunction with this project.

Some of the page design used here come from SB Admin a free, open source, MIT licensed Bootstrap admin template.

Contribution

Contributions to the Default Project are welcomed and encouraged! Whether it's bug fixes, feature enhancements, or documentation improvements, your contributions help enrich the project and benefit the community. To contribute, simply fork the project, make your changes, and submit a pull request. Be sure to follow the project's contribution guidelines and coding standards to ensure smooth integration of your contributions.

Feedback

Your feedback is invaluable in shaping the future direction of the Default Project. Whether you have suggestions for improvements, encounter issues, or simply want to share your experiences, we welcome your feedback. Feel free to reach out through the project's issue tracker, discussion forums, or community channels to share your thoughts and contribute to the ongoing evolution of the project.

see7e/django_company-modules