Clean and organize project structure
Major reorganization: - Created scripts/ directory for all utility scripts - Created config/ directory for configuration files - Moved all test files to tests/ directory - Updated all script paths to work with new structure - Updated README.md with new project structure diagram New structure: ├── src/ # Source code (API + MCP) ├── scripts/ # Utility scripts (start-*.sh, docs_server.py, etc.) ├── tests/ # All test files and debug utilities ├── config/ # Configuration files (JSON, Caddy config) ├── docs/ # Documentation website └── logs/ # Log files All scripts updated to use relative paths from project root. Documentation updated with new folder structure. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
71
README.md
71
README.md
@@ -34,13 +34,13 @@ LangMem uses a hybrid approach combining:
|
||||
|
||||
```bash
|
||||
git clone <repository>
|
||||
cd langmem-project
|
||||
cd langmem
|
||||
```
|
||||
|
||||
### 2. Start Development Environment
|
||||
|
||||
```bash
|
||||
./start-dev.sh
|
||||
./scripts/start-dev.sh
|
||||
```
|
||||
|
||||
This will:
|
||||
@@ -52,7 +52,7 @@ This will:
|
||||
### 3. Test the API
|
||||
|
||||
```bash
|
||||
./test.sh
|
||||
./scripts/test.sh
|
||||
```
|
||||
|
||||
## API Endpoints
|
||||
@@ -139,39 +139,60 @@ NEO4J_PASSWORD=langmem_neo4j_password
|
||||
### Project Structure
|
||||
|
||||
```
|
||||
langmem-project/
|
||||
├── src/
|
||||
│ └── api/
|
||||
│ └── main.py # Main API application
|
||||
├── tests/
|
||||
│ ├── test_api.py # API unit tests
|
||||
│ ├── test_integration.py # Integration tests
|
||||
│ └── conftest.py # Test configuration
|
||||
├── docker-compose.yml # Docker services
|
||||
├── Dockerfile # API container
|
||||
├── requirements.txt # Python dependencies
|
||||
├── start-dev.sh # Development startup
|
||||
├── test.sh # Test runner
|
||||
└── README.md # This file
|
||||
langmem/
|
||||
├── src/ # Source code
|
||||
│ ├── api/ # FastAPI application
|
||||
│ │ ├── main.py # Main API server
|
||||
│ │ ├── fact_extraction.py # Fact-based memory logic
|
||||
│ │ └── memory_manager.py # Memory management
|
||||
│ └── mcp/ # Model Context Protocol
|
||||
│ ├── server.py # MCP server for Claude Code
|
||||
│ └── requirements.txt
|
||||
├── scripts/ # Utility scripts
|
||||
│ ├── start-dev.sh # Development startup
|
||||
│ ├── start-mcp-server.sh # MCP server startup
|
||||
│ ├── start-docs-server.sh # Documentation server
|
||||
│ ├── docs_server.py # Authenticated docs server
|
||||
│ ├── get-claude-token.py # Matrix setup utility
|
||||
│ └── test.sh # Test runner
|
||||
├── tests/ # Test suite
|
||||
│ ├── test_api.py # API tests
|
||||
│ ├── test_integration.py # Integration tests
|
||||
│ ├── test_fact_based_memory.py # Fact extraction tests
|
||||
│ ├── debug_*.py # Debug utilities
|
||||
│ └── conftest.py # Test configuration
|
||||
├── docs/ # Documentation website
|
||||
│ ├── index.html # Main documentation
|
||||
│ ├── api/ # API documentation
|
||||
│ ├── architecture/ # Architecture docs
|
||||
│ └── implementation/ # Setup guides
|
||||
├── config/ # Configuration files
|
||||
│ ├── mcp_config.json # MCP server config
|
||||
│ ├── claude-matrix-config.json # Matrix setup
|
||||
│ └── caddyfile-docs-update.txt # Caddy config
|
||||
├── docker-compose.yml # Docker services
|
||||
├── Dockerfile # API container
|
||||
├── requirements.txt # Python dependencies
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
### Running Tests
|
||||
|
||||
```bash
|
||||
# All tests
|
||||
./test.sh all
|
||||
./scripts/test.sh all
|
||||
|
||||
# Unit tests only
|
||||
./test.sh unit
|
||||
./scripts/test.sh unit
|
||||
|
||||
# Integration tests only
|
||||
./test.sh integration
|
||||
./scripts/test.sh integration
|
||||
|
||||
# Quick tests (no slow tests)
|
||||
./test.sh quick
|
||||
./scripts/test.sh quick
|
||||
|
||||
# With coverage
|
||||
./test.sh coverage
|
||||
./scripts/test.sh coverage
|
||||
```
|
||||
|
||||
### Local Development
|
||||
@@ -289,10 +310,10 @@ Start the authenticated documentation server:
|
||||
|
||||
```bash
|
||||
# Start documentation server on port 8080 (default)
|
||||
./start-docs-server.sh
|
||||
./scripts/start-docs-server.sh
|
||||
|
||||
# Or specify a custom port
|
||||
./start-docs-server.sh 8090
|
||||
./scripts/start-docs-server.sh 8090
|
||||
```
|
||||
|
||||
**Access Credentials:**
|
||||
@@ -310,7 +331,7 @@ Start the authenticated documentation server:
|
||||
You can also run the documentation server directly:
|
||||
|
||||
```bash
|
||||
python3 docs_server.py [port]
|
||||
python3 scripts/docs_server.py [port]
|
||||
```
|
||||
|
||||
Then visit: `http://localhost:8080` (or your specified port)
|
||||
|
||||
Reference in New Issue
Block a user