Djuix.io Docs

Djuix.io

Interface

After creating a project, you'll see the Usage Alert at the top, which displays the number of projects you've created. Below this, you’ll find the project card, which includes the project name and, if provided, a brief description.

In the top right corner of the project card, there’s a dropdown button that allows you to edit or delete your project. Within the card, an arrow button lets you navigate into the project, where you can access the apps and other features of your standard Django application.

Interface Overview.mov

Key Components

Djuix is a powerful tool that leverages Django and Django Rest Framework to simplify API creation. This documentation will guide you through the key components of Djuix, making it accessible for both technical and non-technical users.

Django and Django Rest Framework

Djuix seamlessly integrates Django and Django Rest Framework (DRF) to provide a robust foundation for API development.

• Django: A high-level Python web framework that encourages rapid development and clean, pragmatic design. The framework powers millions of websites worldwide, including Instagram and Mozilla etc. It follows the "batteries included" philosophy, providing:
  • Robust security features
  • Scalable architecture
  • Extensive documentation
  • Active community support
• Django Rest Framework: A powerful and flexible toolkit for building Web APIs with Django, offering:
  • Powerful serialization engine
  • Authentication policies
  • Browsable API
  • Extensive documentation

By combining these technologies, Djuix offers a user-friendly interface for creating APIs without sacrificing the power and flexibility of Django and DRF.

Project Structure

In Djuix, a project consists of one or more apps, each containing

• Models(data structure),
• Serializers(data transformation),
• Views(business logic), and
• URLs(routing).

This structure aligns with Django's best practices for organizing code.

Side Navigation Bar

The side navigation bar provides easy access to your project and also more features within a standard Django project. Djuix organizes these into categories for improved usability and manageable visuality:

1. Home → Takes you to the current project apps
2. Configs → THis includes your django project settings i.e the one that can be setup in your regular settings.py
   • Settings
     • Basic Settings
     • Database COnfig
     • File Config
     • Pagination
3. Plugins → Artificats for your app.
   • Plugins
     • Auth → Authentication
     • Download → Exporting your project out from Djuix
4. Apps → All the Apps within the current project

💡 Pro Tip: Click the "View" in any drop-down menu to see the code-style configuration, perfect for developers who want to understand the underlying structure.

Basic Settings

The Basic Settings section allows you to configure fundamental project parameters:

• Debug: Set to true for development, false for production
• Allowed Hosts: Specifies which hosts are allowed to serve the application
• Root URL Config: Defines the root URLconf module (e.g., health_care_system.urls)
• Language Code: Sets the language for the project (e.g., en-us)
• Time Zone: Specifies the time zone (e.g., UTC)
• Use CORS: Enables Cross-Origin Resource Sharing
• Generate secret key for your Django project.

For a more detailed view, users can click the three dot icon and select "View Code" to see how these settings are structured in the actual Django settings.py file.

Basic Settings.mov

Database Config

Djuix simplifies database selection and configuration. Currently supported databases include:

• MySQL
• PostgreSQL
• SQLite

Note: While SQLite files are temporary, Djuix ensures data safety through careful handling and separation of databases.

Database Config.mov

File Config

Djuix provides an intuitive UI for managing file storage, offering flexibility in choosing between:

• Cloudinary

• Amazon S3

• Local Storage

  Cloudinary Configuration

  Required fields:

  • Storage Type: Cloudinary
  • Cloud Name
  • API Key
  • API Secret (securely stored and hidden)

  ---

  Amazon S3 Configuration

  Required fields:

  • Storage Type: S3
  • AWS Bucket Name
  • AWS Access Key (securely stored and hidden)
  • AWS Secret Access Key (securely stored and hidden)

  ---

  Local Storage Configuration

  Simply select "Local" as the storage type.

File Config.mov

Pagination

Djuix allows easy configuration of pagination settings for your API endpoints, aligning with Django Rest Framework's pagination options.

Required fields:

• Page Size: Number of items per page
• Page Size Query Param: Query parameter key for page size
• Page Query Param: Query parameter key for page number
• Maximum Page Size: Maximum number of items allowed per page