Update README.md to provide a comprehensive overview of The Order monorepo, including repository structure, quickstart guide, development workflow, and contribution guidelines.

This commit is contained in:
defiQUG
2025-11-07 22:34:54 -08:00
parent e020318829
commit 4af7580f7a
128 changed files with 4558 additions and 2 deletions

36
scripts/add-submodules.sh Executable file
View File

@@ -0,0 +1,36 @@
#!/bin/bash
# Script to add Git submodules to The Order monorepo
# Replace URLs with your actual repository URLs
set -e
echo "Adding Git submodules to The Order monorepo..."
# Apps
echo "Adding app submodules..."
git submodule add https://github.com/the-order/portal-public.git apps/portal-public || echo "portal-public already exists or URL incorrect"
git submodule add https://github.com/the-order/portal-internal.git apps/portal-internal || echo "portal-internal already exists or URL incorrect"
git submodule add https://github.com/the-order/mcp-members.git apps/mcp-members || echo "mcp-members already exists or URL incorrect"
git submodule add https://github.com/the-order/mcp-legal.git apps/mcp-legal || echo "mcp-legal already exists or URL incorrect"
# Services
echo "Adding service submodules..."
git submodule add https://github.com/the-order/intake.git services/intake || echo "intake already exists or URL incorrect"
git submodule add https://github.com/the-order/identity.git services/identity || echo "identity already exists or URL incorrect"
git submodule add https://github.com/the-order/finance.git services/finance || echo "finance already exists or URL incorrect"
git submodule add https://github.com/the-order/dataroom.git services/dataroom || echo "dataroom already exists or URL incorrect"
git submodule add https://github.com/the-order/omnis-brand.git services/omnis-brand || echo "omnis-brand already exists or URL incorrect"
git submodule add https://github.com/the-order/arromis-brand.git services/arromis-brand || echo "arromis-brand already exists or URL incorrect"
# Initialize and update submodules
echo "Initializing submodules..."
git submodule update --init --recursive
echo "Submodules added successfully!"
echo ""
echo "To update submodules later, run:"
echo " git submodule update --remote"
echo ""
echo "To clone this repo with submodules, run:"
echo " git clone --recurse-submodules <repo-url>"

41
scripts/dev.sh Executable file
View File

@@ -0,0 +1,41 @@
#!/bin/bash
# Development helper script
set -e
case "$1" in
start)
echo "Starting development environment..."
docker-compose up -d
echo "Waiting for services to be ready..."
sleep 5
pnpm dev
;;
stop)
echo "Stopping development environment..."
docker-compose down
;;
restart)
echo "Restarting development environment..."
docker-compose restart
;;
logs)
docker-compose logs -f
;;
clean)
echo "Cleaning development environment..."
docker-compose down -v
pnpm clean
;;
*)
echo "Usage: $0 {start|stop|restart|logs|clean}"
echo ""
echo " start - Start Docker services and run dev servers"
echo " stop - Stop Docker services"
echo " restart - Restart Docker services"
echo " logs - Show Docker logs"
echo " clean - Stop services and remove volumes"
exit 1
;;
esac