Skip to content

Latest commit

 

History

History
166 lines (128 loc) · 5.69 KB

README.md

File metadata and controls

166 lines (128 loc) · 5.69 KB

ThemisDB Tutorials

Hands-on guides to help you master ThemisDB from basics to advanced techniques.

🎯 Choose Your Learning Path

Your Role Start Here Then Continue Advanced
New User Getting Started CRUD Operations Interactive Examples
Developer CRUD Operations Batch Operations Best Practices
Architect Schema Design Best Practices Performance Guide
Visual Learner Video Tutorials Interactive Examples Use Cases

📚 Tutorial Index

Getting Started

  • Getting Started Tutorial - Your first steps with ThemisDB
    • Installation methods (Docker, binary, source)
    • First connection and database creation
    • Basic CRUD operations
    • Simple queries and indexes
    • Time: 30-45 minutes

Core Operations

  • CRUD Operations Tutorial - Master create, read, update, and delete operations

    • Entity management
    • Bulk operations
    • Conditional updates
    • Upserts and merges
    • Time: 30 minutes

  • Batch Operations Guide - Efficient bulk data handling

    • Batch inserts and updates
    • Transaction batching
    • Performance optimization
    • Error handling strategies
    • Time: 25 minutes

Advanced Topics

  • Schema Design Tutorial - Design optimal database schemas

    • Multi-model schema design
    • Normalization vs. denormalization
    • Index strategies
    • Real-world patterns
    • Time: 45 minutes

  • Best Practices Guide - Production-ready patterns

    • Query optimization
    • Security best practices
    • Performance tuning
    • Error handling
    • Time: 40 minutes

Interactive Learning

  • Interactive Examples - Try it yourself!

    • Code snippets with explanations
    • Common patterns
    • Real-world scenarios
    • Links to runnable examples
    • Time: varies

  • Video Tutorials - Visual learning resources

    • Video series index
    • Feature deep-dives
    • Use case walkthroughs
    • Time: varies

🎯 Learning Paths

For Beginners (0-1 month experience)

  1. Getting Started Tutorial
  2. CRUD Operations Tutorial
  3. Interactive Examples
  4. Practice with Hello World Example

For Application Developers (1-3 months experience)

  1. Batch Operations Guide
  2. Schema Design Tutorial
  3. Best Practices Guide
  4. Build a Todo App

For Database Architects (3+ months experience)

  1. Schema Design Tutorial
  2. Best Practices Guide
  3. Review Performance Guide
  4. Study Architecture Documentation

📖 Documentation Structure

docs/
├── tutorials/              ← You are here
│   ├── GETTING_STARTED_TUTORIAL.md
│   ├── CRUD_TUTORIAL.md
│   ├── BATCH_OPERATIONS.md
│   ├── SCHEMA_DESIGN.md
│   ├── BEST_PRACTICES.md
│   ├── INTERACTIVE_EXAMPLES.md
│   └── VIDEO_TUTORIALS.md
├── api/                    # API Reference
├── architecture/           # System Architecture
├── deployment/            # Deployment Guides
├── performance/           # Performance Tuning
└── examples/              # Example Applications

🚀 Quick Start

If you're completely new to ThemisDB:

  1. Install ThemisDB (choose one):

    # Docker (recommended)
docker run -d -p 8080:8080 themisdb/themisdb:latest

# Or from source
git clone https://github.com/makr-code/ThemisDB.git
cd ThemisDB && ./scripts/setup.sh && ./scripts/build.sh

  2. Follow the Getting Started Tutorial

  3. Try the Interactive Examples

  4. Build something! Pick an example from /examples directory

💡 Tips for Learning

  • Hands-On First: Start with the Getting Started tutorial and type every command
  • Build Projects: The best way to learn is by building real applications
  • Use Examples: Explore the 20+ examples in /examples directory
  • Ask Questions: Join our community on GitHub Discussions
  • Read Error Messages: ThemisDB has helpful error messages - read them!

🆘 Need Help?

📝 Contributing

Found an error or want to improve a tutorial? Contributions are welcome!

  1. Fork the repository
  2. Edit the tutorial
  3. Submit a pull request

See CONTRIBUTING.md for guidelines.

🔗 Related Resources

Ready to start? Begin with the Getting Started Tutorial →