Skip to main content

Quick Start Guide

Get MakeItMakeSense.io up and running in minutes.

Prerequisites​

  • Docker & Docker Compose, Node.js 18+, Python 3.7+, Git

For detailed requirements and Python environment setup, see Complete Setup Guide

5-Minute Setup​

1. Clone and Install​

# Clone and install dependencies
git clone https://github.com/heythisisgordon/mims-graph.git
cd mims-graph
npm install  # Installs all dependencies concurrently

2. Configure Environment​

cp api/.env.example api/.env
# Edit api/.env if needed (optional for basic local development)

3. Start Everything​

# Start the complete development environment
npm run start-dev-env

This single command:

  • ✅ Starts Dgraph database via Docker
  • ✅ Starts the API server with hot-reload
  • ✅ Starts the frontend with hot-reload

4. Initialize Database​

In a separate terminal:

# Initialize the database schema
python tools/api_push_schema.py --target local

5. Access the Application​

Optional: Add Sample Data​

# Add sample nodes and relationships
python tools/seed_data.py

Stopping the Environment​

Press Ctrl+C in the terminal running npm run start-dev-env, then:

npm run stop-dgraph

Troubleshooting​

Quick Fixes​

  • Docker issues: docker ps to check status
  • Port conflicts: Check if ports 3000, 5173, 8080 are available
  • Schema push fails: Ensure Dgraph is running with docker ps | grep dgraph

For comprehensive troubleshooting, see Complete Setup Guide

Getting Help​

What's Next?​

Once you have the system running:

  1. Explore the Graph: Interact with nodes and relationships in the frontend
  2. Learn the Architecture: Understand the system design
  3. Try Multi-Tenant Features: Set up multiple tenants
  4. Review the API: Explore available endpoints
  5. Set Up Testing: Run the comprehensive test suite

Multi-Tenant Quick Test​

# Enable multi-tenant mode and restart
echo "ENABLE_MULTI_TENANT=true" >> api/.env
# Restart with: Ctrl+C then npm run start-dev-env

# Create test tenant and seed data
curl -X POST http://localhost:3000/api/tenant \
  -H "X-Admin-API-Key: your-key" -d '{"tenantId": "test-company"}'
python tools/seed_data.py --tenant-id test-company

For complete multi-tenant setup, see Multi-Tenant Guide

Need more detailed setup instructions? Check out our Complete Setup Guide for comprehensive configuration options, production deployment, and advanced features.