67 lines
No EOL
1.9 KiB
Markdown
67 lines
No EOL
1.9 KiB
Markdown
# Getting Started with Brainy
|
|
|
|
Welcome to Brainy! This section provides everything you need to get up and running with the world's smartest vector database.
|
|
|
|
## 🚀 Quick Navigation
|
|
|
|
### [📦 Installation Guide](installation.md)
|
|
Learn how to install Brainy and set up your environment.
|
|
|
|
- Package installation options
|
|
- Environment requirements
|
|
- Verification steps
|
|
|
|
### [⚡ Quick Start Guide](quick-start.md)
|
|
Get your first Brainy application running in minutes.
|
|
|
|
- Zero-configuration setup
|
|
- Basic usage examples
|
|
- Auto-configuration features
|
|
|
|
### [🛠️ Environment Setup](environment-setup.md)
|
|
Configure your development environment for optimal performance.
|
|
|
|
- Development vs production settings
|
|
- Environment-specific optimizations
|
|
- Storage configuration
|
|
|
|
### [👶 First Steps](first-steps.md)
|
|
A guided tutorial through Brainy's core features.
|
|
|
|
- Your first vector database
|
|
- Adding and searching data
|
|
- Understanding search results
|
|
- Graph relationships
|
|
|
|
## 🎯 What You'll Learn
|
|
|
|
By the end of this section, you'll understand:
|
|
|
|
- ✅ How to install and set up Brainy
|
|
- ✅ Brainy's zero-configuration auto-optimization
|
|
- ✅ Basic vector operations and search
|
|
- ✅ How to choose storage options
|
|
- ✅ Performance optimization basics
|
|
|
|
## 🏃♂️ I'm in a Hurry!
|
|
|
|
If you just want to get started immediately:
|
|
|
|
1. **Install**: `npm install @soulcraft/brainy`
|
|
2. **Use**:
|
|
```typescript
|
|
import { createAutoBrainy } from '@soulcraft/brainy'
|
|
const brainy = createAutoBrainy()
|
|
```
|
|
3. **Done!** Everything else is auto-configured.
|
|
|
|
See the [Quick Start Guide](quick-start.md) for complete examples.
|
|
|
|
## 🔄 Next Steps
|
|
|
|
After completing the getting started guides:
|
|
|
|
- 📖 [User Guides](../user-guides/) - Learn advanced features
|
|
- ⚡ [Optimization Guides](../optimization-guides/) - Scale to millions
|
|
- 🔧 [API Reference](../api-reference/) - Complete API documentation
|
|
- 💡 [Examples](../examples/) - Real-world code examples |