Skip to content

Commit b5c4f63

Browse files
author
Matthew Valancy
committed
Reorganize repository structure for cleaner top-level directory
- Move development scripts to tools/ folder - setup.sh, run.sh, test.sh, build.sh, deploy.sh, document.sh - Move Docker configuration to deployment/ folder - Dockerfile, docker-compose.yml, docker-compose.dev.yml - Update all script references throughout documentation - Update Docker paths in setup and run scripts - Maintain git history with git mv for moved files Top level now contains only essential files: - README.md, LICENSE, package.json (core project files) - CLAUDE.md, tsconfig.json, turbo.json (configuration) - packages/, docs/, scripts/ (main directories)
1 parent 8c0a4ec commit b5c4f63

15 files changed

Lines changed: 51 additions & 51 deletions

CLAUDE.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ The project has a fully implemented monorepo structure with these commands:
4444

4545
```bash
4646
# Quick setup (recommended)
47-
./setup.sh # Complete environment setup
48-
./run.sh # Start all development servers
47+
./tools/setup.sh # Complete environment setup
48+
./tools/run.sh # Start all development servers
4949

5050
# Manual setup
5151
npm install # Install dependencies
@@ -65,7 +65,7 @@ npm run db:migrate # Run Prisma migrations
6565
npm run db:seed # Seed database with test data
6666

6767
# Docker development
68-
docker-compose -f docker-compose.dev.yml up # With hot reload
68+
docker-compose -f deployment/docker-compose.dev.yml up # With hot reload
6969
docker-compose up # Production-like environment
7070
```
7171

@@ -103,21 +103,21 @@ When implementing features:
103103

104104
```bash
105105
# Initial setup
106-
./setup.sh # Set up development environment
107-
./run.sh # Start development servers
108-
./test.sh # Run test suite with linting and type checking
109-
./build.sh # Build all packages
110-
./deploy.sh # Deploy to staging/production
111-
./document.sh # Generate and deploy documentation
106+
./tools/setup.sh # Set up development environment
107+
./tools/run.sh # Start development servers
108+
./tools/test.sh # Run test suite with linting and type checking
109+
./tools/build.sh # Build all packages
110+
./tools/deploy.sh # Deploy to staging/production
111+
./tools/document.sh # Generate and deploy documentation
112112

113113
# Docker development
114-
./run.sh --docker-dev # Start with Docker (development)
115-
./run.sh --docker # Start with Docker (production)
114+
./tools/run.sh --docker-dev # Start with Docker (development)
115+
./tools/run.sh --docker # Start with Docker (production)
116116

117117
# Package-specific testing
118-
./test.sh --package core # Test specific package
119-
./test.sh --coverage # Run with coverage report
120-
./test.sh --watch # Run in watch mode
118+
./tools/test.sh --package core # Test specific package
119+
./tools/test.sh --coverage # Run with coverage report
120+
./tools/test.sh --watch # Run in watch mode
121121

122122
# Turbo commands (alternative)
123123
npm run dev # Start all development servers
@@ -151,8 +151,8 @@ npm run typecheck # Type check all packages
151151

152152
🎯 **Ready for Development:**
153153
All foundation pieces are in place. To continue development:
154-
1. Run `./setup.sh` to initialize the development environment
155-
2. Use `./run.sh` to start development servers
154+
1. Run `./tools/setup.sh` to initialize the development environment
155+
2. Use `./tools/run.sh` to start development servers
156156
3. Access the working application at http://localhost:3000
157157
4. Use GraphQL Playground at http://localhost:4000/graphql
158158
5. Begin implementing specific features using the established patterns

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ GraphDone is built on the belief that:
4949
```bash
5050
git clone https://github.com/your-org/graphdone.git
5151
cd graphdone
52-
./setup.sh
53-
./run.sh
52+
./tools/setup.sh
53+
./tools/run.sh
5454
```
5555

5656
Visit http://localhost:3000 to see the working application!
@@ -96,7 +96,7 @@ GraphDone is built for and by teams who think differently. We welcome contributi
9696
- Performance for large graphs
9797

9898
**Get Started:**
99-
1. Run `./setup.sh && ./run.sh` to see the system working
99+
1. Run `./tools/setup.sh && ./tools/run.sh` to see the system working
100100
2. Read our [philosophy](./docs/philosophy.md) and [architecture](./docs/guides/architecture-overview.md)
101101
3. Pick an area that excites you and matches your skills
102102
4. Join discussions in GitHub Issues and pull requests
File renamed without changes.

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,22 @@ Welcome to the GraphDone documentation! This directory contains comprehensive gu
3434

3535
1. **Setup Development Environment**
3636
```bash
37-
./setup.sh
37+
./tools/setup.sh
3838
```
3939

4040
2. **Start Development Servers**
4141
```bash
42-
./run.sh
42+
./tools/run.sh
4343
```
4444

4545
3. **Run Tests**
4646
```bash
47-
./test.sh
47+
./tools/test.sh
4848
```
4949

5050
4. **Build for Production**
5151
```bash
52-
./build.sh --production
52+
./tools/build.sh --production
5353
```
5454

5555
## 📖 Key Concepts

docs/deployment/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ This guide covers various deployment options for GraphDone, from local developme
88

99
### Development (Local)
1010
```bash
11-
./run.sh
11+
./tools/run.sh
1212
```
1313

1414
### Development (Docker)
1515
```bash
16-
./run.sh --docker-dev
16+
./tools/run.sh --docker-dev
1717
```
1818

1919
### Production (Docker)
2020
```bash
21-
./run.sh --docker
21+
./tools/run.sh --docker
2222
```
2323

2424
## Environment Variables

docs/detailed-overview.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ graphdone/
275275
│ └── deployment/ # Deployment guides
276276
├── scripts/ # Development and deployment scripts
277277
├── .github/workflows/ # CI/CD pipelines
278-
└── docker-compose.yml # Development environment
278+
└── deployment/ # Docker and deployment files
279279
```
280280

281281
## Technology Stack & Implementation
@@ -480,7 +480,7 @@ GraphDone includes a comprehensive setup script that handles all prerequisites a
480480
# Clone and setup
481481
git clone https://github.com/your-org/graphdone.git
482482
cd graphdone
483-
./setup.sh
483+
./tools/setup.sh
484484
```
485485

486486
The setup script will:
@@ -495,27 +495,27 @@ The setup script will:
495495

496496
```mermaid
497497
graph LR
498-
START[./setup.sh] --> DEV[./run.sh]
499-
DEV --> TEST[./test.sh]
500-
TEST --> BUILD[./build.sh]
501-
BUILD --> DEPLOY[./deploy.sh]
498+
START[./tools/setup.sh] --> DEV[./tools/run.sh]
499+
DEV --> TEST[./tools/test.sh]
500+
TEST --> BUILD[./tools/build.sh]
501+
BUILD --> DEPLOY[./tools/deploy.sh]
502502
503503
DEV -.-> CODE[Code Changes]
504504
CODE -.-> DEV
505505
506506
subgraph "Available Commands"
507-
RUN1[./run.sh --docker-dev]
508-
RUN2[./test.sh --coverage]
509-
RUN3[./test.sh --package core]
510-
BUILD1[./build.sh --production]
507+
RUN1[./tools/run.sh --docker-dev]
508+
RUN2[./tools/test.sh --coverage]
509+
RUN3[./tools/test.sh --package core]
510+
BUILD1[./tools/build.sh --production]
511511
end
512512
```
513513

514514
### Running the System
515515

516516
Start all development servers:
517517
```bash
518-
./run.sh
518+
./tools/run.sh
519519
```
520520

521521
This provides:
@@ -550,10 +550,10 @@ For containerized development:
550550

551551
```bash
552552
# Full Docker development environment
553-
./run.sh --docker-dev
553+
./tools/run.sh --docker-dev
554554

555555
# Production-like environment
556-
./run.sh --docker
556+
./tools/run.sh --docker
557557

558558
# Individual service testing
559559
docker-compose up -d postgres # Database only
@@ -666,8 +666,8 @@ agent.subscribe('node.priorityChanged', async (node) => {
666666
# Get started in 30 seconds
667667
git clone https://github.com/your-org/graphdone.git
668668
cd graphdone
669-
./setup.sh
670-
./run.sh
669+
./tools/setup.sh
670+
./tools/run.sh
671671
```
672672

673673
Visit http://localhost:3000 to see the working application!
@@ -710,16 +710,16 @@ GraphDone is built for and by teams who think differently. We welcome contributi
710710
### 🔧 **Development Workflow**
711711
```bash
712712
# Set up development environment
713-
./setup.sh
713+
./tools/setup.sh
714714

715715
# Make your changes
716716
git checkout -b feature/your-improvement
717717

718718
# Test your changes
719-
./test.sh --coverage
719+
./tools/test.sh --coverage
720720

721721
# Build and verify
722-
./build.sh
722+
./tools/build.sh
723723

724724
# Submit your contribution
725725
git push origin feature/your-improvement

docs/guides/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ git clone https://github.com/your-org/graphdone.git
2323
cd graphdone
2424

2525
# Run setup script
26-
./setup.sh
26+
./tools/setup.sh
2727
```
2828

2929
The setup script will:
@@ -60,7 +60,7 @@ npm run build
6060
Start the development servers:
6161

6262
```bash
63-
./run.sh
63+
./tools/run.sh
6464
```
6565

6666
This will start:
File renamed without changes.

0 commit comments

Comments
 (0)