User Guide

Complete guide to using MinerSheets effectively

End-User Tutorial & Feature Guide

Quick Start Guide

1️⃣

Create Your First Model

Start by visiting the Model Factory to create your first custom Model Data with fields and relationships.

2️⃣

Add Your Data

Use the Intuitive Interface to add, edit, and Manage Your Data records with powerful CRUD operations.

3️⃣

Explore & Analyze

View your data in beautiful Interfaces, export reports, and leverage relationships between models.

Guide Sections

Getting Started with MinerSheets

🚀 First Login

After Creating your account, you'll be taken to the Dashboard where you can see:

• Overview of Your Data Models
• Total record counts
• Quick access to common actions
• Recent activity summary

🏗️ Understanding the Interface

Main Navigation

• Dashboard: Overview and statistics
• Models: Data Browsing and management
• Factory: Model Creation and editing

User menu

• Profile settings and preferences
• Account management
• Logout and security options

📚 Key Concepts

Models

Custom data structures you create to store and organize your information, similar to database tables but more flexible.

Fields

Individual data elements within a model, such as text, numbers, dates, or relationships to other models.

Model Factory Guide

Creating Your First Model

1. Navigate to the factory section in the admin Interface
2. Click "Add Custom model"
3. Fill in the model details:
- • Name: Internal identifier (e.g., "Companies")
- • Verbose Name: Display name (e.g., "Company Directory")
- • Display field: Which field to show in relationships
4. Add fields using the inline form at the bottom
5. Save your model to create it in the database

Available field Types

CharField: Short text (up to 255 characters)

TextField: Long text (unlimited length)

IntegerField: Whole numbers

BooleanField: True/False values

DateField: Date only (YYYY-MM-DD)

DateTimeField: Date and time

ForeignKey: Link to another model (one-to-many)

OneToOneField: Unique link to another model

ManyToManyField: Multiple links to another model

field Configuration

field Name: Internal identifier (lowercase, no spaces)

Verbose Name: Display label for the field

Is Required: Whether the field must be filled

Related Model: For relationship fields only

Related Display Field: Which field to show from related model

⚠️ Important Notes

• Once created, field types cannot be changed
• Deleting a model will permanently remove all its data
• model names must be unique and cannot contain spaces
• Always test with Sample Data before adding production data

Data Management

➕ Adding Records

• Click "Add New" button
• Fill in required fields
• Use dropdowns for relationships
• Save to create the record

✏️ Editing Records

• Click the edit icon on any record
• Modify fields as needed
• Changes are saved automatically
• View change history

🗑️ Deleting Records

• Click the delete icon
• Confirm deletion in popup
• Related records may be affected
• Action cannot be undone

Bulk Operations

Selection Methods

• Check individual record checkboxes
• Use "Select All" for entire page
• Filter first, then select visible records
• Selection persists across page navigation

Available Actions

• Bulk Delete: Remove multiple records
• Bulk Edit: Update common fields
• Bulk Duplicate: Copy selected records
• Export: Download Data in Various Formats

🔍 Search and Filtering

Search Features

• Global search across all fields
• field-specific search options
• Case-insensitive matching
• Partial text matching

Filter Options

• Date range filtering
• Relationship-based filters
• Boolean value filters
• Custom filter combinations

Advanced Features

🔗 Relationship Management

ForeignKey (One-to-Many):

Each record can be linked to one record in another model. Example: Each employee belongs to one company.

OneToOne:

Unique one-to-one relationship. Example: Each user has one profile.

ManyToMany:

Multiple connections between models. Example: Employees can work on multiple projects.

📊 data export

CSV Export: Spreadsheet-compatible format

JSON Export: Structured Data for APIs

Excel Export: Native Excel format

PDF Reports: Formatted printable reports

Tip: Use filters before exporting to get only the Data You Need.

🎨 UI Customization

Display field Selection

Choose which field appears when your model is referenced by others. Makes relationships more meaningful.

field Ordering

Arrange fields in logical order for better User Experience. Most important fields should come first.

Verbose Names

Use clear, descriptive names for models and fields that non-technical users can understand.

🚀 Performance Tips

• Use pagination for large datasets (automatically enabled)
• Index frequently searched fields for better performance
• Limit relationship depth to avoid circular references
• Regular cleanup of unnecessary data and models
• Use bulk operations for large-scale changes

Troubleshooting

Common Issues and Solutions

❌ "field not found" error when Creating Models

Cause: Related model or field doesn't exist

Solution: Create the related model first, or check field name spelling

⚠️ data not saving in forms

Cause: Required fields missing or Validation Errors

Solution: Check all required fields are filled and data formats are correct

🔒 Permission denied errors

Cause: Insufficient user permissions

Solution: Contact administrator to grant necessary permissions

🔧 Best Practices

• Always backup important data before major changes
• Test new models with Sample Data first
• Use descriptive names for models and fields
• Document your Model Data structure
• Regular maintenance of unused models
• Monitor performance with large datasets

📞 Getting Help

Documentation:

Comprehensive guides and API reference

Support Forum:

Community discussions and solutions

Contact Support:

Direct help from our technical team

Submit Support request

Quick Reference

🔗 Important Links

⌨️ Keyboard Shortcuts

Ctrl+N New Record
Ctrl+S Save Changes
Ctrl+F Search
Esc Close Modal

💡 Pro Tips

Use Ctrl+Click for bulk selection
Double-click to quick-edit records
Right-click for context menus
Use filters to find data faster