mirror of https://github.com/johndoe6345789/metabuilder.git synced 2026-04-25 06:14:59 +00:00

Files

johndoe6345789 bdcee38a12 feat(tests): Implement comprehensive unit testing framework and documentation

- Created multiple test files for utility functions and hooks, ensuring coverage for all core functionalities.
- Developed test infrastructure scripts for analyzing and reporting test coverage.
- Added detailed testing guidelines and quick reference documentation for developers.
- Established a unit test checklist to track implementation progress and ensure best practices.
- Updated the documentation index to include new testing resources and guides.

2025-12-25 12:43:52 +00:00

3.8 KiB

Raw Blame History

Getting Started with MetaBuilder

Welcome to MetaBuilder! This section has everything you need to get up and running.

Quick Start (5 minutes)

Clone the repository

git clone https://github.com/yourusername/metabuilder
cd metabuilder

Install dependencies
```
npm install
```
Set up the database
```
npm run db:generate
npm run db:push
```
Start the development server
```
npm run dev
```

The application will be available at http://localhost:3000

What's Next?

PRD.md - Learn about all features and requirements
QUICK_START.md - Detailed setup instructions
Architecture Overview - Understand the system design

Key Concepts

MetaBuilder is Data-Driven

95% of functionality is defined through JSON and Lua configuration, not TypeScript. This makes it:

Flexible: Change behavior without recompiling
Multi-tenant: Each tenant has isolated configurations
Declarative: Define what you want, not how to do it

Five-Level Architecture

The system uses a sophisticated 5-level hierarchy:

Global system configuration
Tenant-specific features
Module and package definitions
Entity and form configurations
Individual records and data

Learn more about the 5-level system

Common Tasks

I want to...

...understand what MetaBuilder does → Read PRD.md

...understand how it works → Read 5-Level System

...write code → Follow Testing Guidelines

...deploy to production → Check Deployment Guide

...create a new package → Learn about Packages

Development Environment

Requirements

Node.js 18+
npm 9+
PostgreSQL 14+

Useful Commands

# Development
npm run dev           # Start dev server
npm run build         # Production build

# Database
npm run db:generate   # Generate Prisma client
npm run db:push       # Sync schema with database
npm run db:studio     # Open Prisma Studio

# Testing
npm test             # Run tests in watch mode
npm test -- --run    # Run tests once
npm run test:coverage # With coverage report

# Code Quality
npm run lint         # Check for issues
npm run lint:fix     # Auto-fix issues

Documentation Hierarchy

This file (README.md) - Overview and quick start
PRD.md - Features and requirements
Architecture - How it works
Implementation Guides - Detailed tutorials
API Reference - API documentation
Testing - Testing guide
Security - Security practices

Troubleshooting

Port 3000 already in use

# Use a different port
npm run dev -- -p 3001

Database connection failed

Check PostgreSQL is running
Verify .env has correct DATABASE_URL
Run npm run db:push to initialize schema

Tests failing

Ensure database is set up: npm run db:push
Clear node_modules: rm -rf node_modules && npm install
Run tests: npm test -- --run

Getting Help

📚 Check the full documentation index
🔍 Search for your issue in the docs
🐛 Check Troubleshooting
💬 Ask the team

Next Steps

✅ Complete the quick start above
📖 Read PRD.md to understand the product
🏗️ Read 5-Level System to understand the architecture
🧪 Check Testing Guidelines before writing code
🚀 Start building!

Need more details? Check the full documentation index.

3.8 KiB Raw Blame History