fixed things
This commit is contained in:
64
CLAUDE.md
64
CLAUDE.md
@@ -332,10 +332,70 @@ Your specialized development team is ready to deliver the Job Forge AI-powered j
|
||||
|
||||
**Start building your Job Forge prototype!** 🚀
|
||||
|
||||
# Documentation Structure
|
||||
All project documentation is centralized in the `docs/` folder. See [README.md](README.md) for complete documentation navigation.
|
||||
## Project Structure and Organization
|
||||
|
||||
### 📁 Clean Project Structure Requirements
|
||||
**MANDATORY**: Only necessary files should be stored in the project root folder. All supporting files must be organized into appropriate subdirectories:
|
||||
|
||||
```
|
||||
job-forge/
|
||||
├── src/ # Source code only
|
||||
├── tests/ # Test files only
|
||||
├── docs/ # All documentation
|
||||
├── docker/ # All Docker-related files
|
||||
├── database/ # Database scripts and migrations
|
||||
├── .env.example # Environment template
|
||||
├── requirements-*.txt # Python dependencies
|
||||
├── pytest.ini # Test configuration
|
||||
└── README.md # Main project readme
|
||||
```
|
||||
|
||||
### 🔧 Docker Files Organization
|
||||
All Docker-related files are stored in the `docker/` folder:
|
||||
- `docker/docker-compose.yml` - Main orchestration file
|
||||
- `docker/Dockerfile.backend` - Backend container definition
|
||||
- `docker/Dockerfile.frontend` - Frontend container definition
|
||||
|
||||
**Usage**: Run `cd docker && docker compose up -d` to start the environment.
|
||||
|
||||
### 📚 Documentation Structure Requirements
|
||||
All project documentation is centralized in the `docs/` folder:
|
||||
- `docs/lessons-learned/` - **MANDATORY**: All project issues and solutions
|
||||
- `docs/api_specification.md` - API documentation
|
||||
- `docs/database_design.md` - Database schema and design
|
||||
- `docs/development/` - Development guides and standards
|
||||
|
||||
### 📝 Lessons Learned Process
|
||||
**MANDATORY**: For every issue encountered during development:
|
||||
1. Create a new markdown file in `docs/lessons-learned/`
|
||||
2. Use format: `###-issue-name.md` (where ### is sequential number)
|
||||
3. Include: Issue name, description, error messages, root cause, solution, prevention strategy
|
||||
4. Reference the lesson learned in relevant documentation
|
||||
|
||||
### 🏗️ Development Environment Setup
|
||||
```bash
|
||||
# 1. Clone and navigate to project
|
||||
git clone <repository>
|
||||
cd job-forge
|
||||
|
||||
# 2. Set up environment variables
|
||||
cp .env.example .env
|
||||
# Edit .env with your API keys
|
||||
|
||||
# 3. Start development environment
|
||||
cd docker
|
||||
docker compose up -d
|
||||
|
||||
# 4. Access applications
|
||||
# Frontend: http://localhost:8501
|
||||
# Backend: http://localhost:8000
|
||||
# Database: localhost:5432
|
||||
```
|
||||
|
||||
# Important Instructions
|
||||
- **Clean Structure**: Only necessary files in project root
|
||||
- **Docker Organization**: All Docker files in `docker/` folder
|
||||
- **Lessons Learned**: Document all issues in `docs/lessons-learned/`
|
||||
- Focus on Python/FastAPI backend implementation
|
||||
- Use Dash + Mantine for frontend components
|
||||
- Prioritize core job application workflows
|
||||
|
||||
Reference in New Issue
Block a user