"Let's Reggie it!" - An AI-powered co-pilot for ESG and sustainability professionals, designed to help companies navigate complex ESG reporting requirements, compliance frameworks, and sustainability best practices.
Reggie is your AI-powered regulations co-pilot that makes ESG compliance simple and efficient. Whether you're navigating complex sustainability frameworks, generating compliance reports, or analyzing supply chain risks, Reggie is here to help you "Reggie it" - making regulatory compliance as easy as possible.
- 🤖 AI-Powered Chat: Get instant answers to ESG questions using advanced AI
- 📊 Compliance Analysis: Automated compliance checking across major ESG frameworks
- 📁 Document Management: Upload and analyze ESG documents and frameworks
- 📋 Report Generation: Create professional sustainability reports with AI assistance
- 🔍 Supply Chain Analysis: Analyze supply chain sustainability and risks
- 📈 Dashboard & Analytics: Track ESG performance and compliance metrics
- GRI Standards (Global Reporting Initiative)
- SASB Standards (Sustainability Accounting Standards Board)
- TCFD Framework (Task Force on Climate-related Financial Disclosures)
- CSRD Directive (Corporate Sustainability Reporting Directive)
- IFRS Sustainability Standards
- Python 3.8 or higher
- Node.js 16 or higher
- OpenAI API key
-
Clone the repository
git clone <repository-url> cd new-esg-copilot
-
Run the setup script
chmod +x setup.sh ./setup.sh
-
Configure environment
# Update OpenAI API key in backend/.env nano backend/.env -
Start the application
# Start backend ./start_backend.sh # Start frontend (in new terminal) ./start_frontend.sh
-
Access the application
- Frontend: http://localhost:3000
- Backend API: http://localhost:8000
- API Documentation: http://localhost:8000/docs
For production deployment instructions, see PRODUCTION_DEPLOYMENT.md.
- FastAPI: Modern, fast web framework
- LangChain: AI/LLM integration
- ChromaDB: Vector database for document storage
- OpenAI: GPT-4 integration for AI responses
- Pydantic: Data validation and serialization
- React 18: Modern UI framework
- TypeScript: Type-safe development
- Tailwind CSS: Utility-first styling
- Recharts: Data visualization
- React Router: Client-side routing
POST /api/v1/chat/message- Send message to AIPOST /api/v1/compliance/check- Check compliance with frameworksPOST /api/v1/documents/upload- Upload documentsGET /api/v1/reports/generate- Generate reportsGET /api/v1/health- Health check
GET /api/v1/chat/frameworks- List available frameworksGET /api/v1/compliance/frameworks/{framework}/requirements- Get framework requirementsGET /api/v1/compliance/benchmark- Benchmark compliance
# OpenAI Configuration
OPENAI_API_KEY=your_openai_api_key_here
# Security
SECRET_KEY=your-secret-key-here
# API Configuration
DEBUG=False
LOG_LEVEL=INFO
# File Upload
UPLOAD_DIR=./uploads
MAX_FILE_SIZE=52428800REACT_APP_API_URL=http://localhost:8000
REACT_APP_NAME=Reggie - AI Regulations Co-Pilot
REACT_APP_VERSION=1.0.0Upload your ESG documents, frameworks, and company data through the Documents page.
Ask questions about ESG frameworks, compliance requirements, or sustainability best practices.
Run compliance checks against major ESG frameworks to identify gaps and get recommendations.
Create professional sustainability reports with AI assistance.
Track your ESG performance and compliance metrics through the dashboard.
cd backend
source venv/bin/activate
pip install -r requirements.txt
uvicorn main:app --reloadcd frontend
npm install
npm start# Backend tests
cd backend
pytest
# Frontend tests
cd frontend
npm test- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
- All API keys and secrets should be stored in environment variables
- HTTPS is required for production deployments
- Input validation is implemented throughout the application
- CORS is properly configured for security
For support and questions:
- Check the PRODUCTION_DEPLOYMENT.md for deployment issues
- Review the API documentation at
/docswhen running locally - Check application logs for error details
- Create an issue in the repository
This project is licensed under the MIT License - see the LICENSE file for details.
- OpenAI for providing the GPT-4 API
- The ESG and sustainability community for frameworks and best practices
- Contributors and users of this project