.md
This commit is contained in:
@@ -1,12 +1,16 @@
|
||||
# Contributing Guidelines - AI Study Assistant
|
||||
|
||||
> ⚠️ **ATUALIZADO**: Este documento foi corrigido para refletir a arquitetura REAL (Flutter + Firebase apenas).
|
||||
>
|
||||
> **Nota:** Não existe backend Node.js nem Python RAG engine. Toda a lógica está no Flutter.
|
||||
|
||||
## 🤝 HOW TO CONTRIBUTE
|
||||
|
||||
---
|
||||
|
||||
## 📋 OVERVIEW
|
||||
|
||||
Thank you for your interest in contributing to the AI Study Assistant! This guide provides comprehensive information on how to contribute to our project, including development workflows, coding standards, and community guidelines.
|
||||
Thank you for your interest in contributing to the AI Study Assistant! This guide provides information on how to contribute to our Flutter + Firebase project.
|
||||
|
||||
---
|
||||
|
||||
@@ -14,11 +18,10 @@ Thank you for your interest in contributing to the AI Study Assistant! This guid
|
||||
|
||||
### Prerequisites
|
||||
- **Git**: Version 2.30 or higher
|
||||
- **Flutter**: Version 3.41.0+
|
||||
- **Node.js**: Version 18.x LTS
|
||||
- **Python**: Version 3.9+ (for RAG engine)
|
||||
- **Flutter**: Version 3.11.5+ (with Dart 3.0+)
|
||||
- **Firebase CLI**: Latest version
|
||||
- **Code Editor**: VS Code recommended
|
||||
- **Note**: No Node.js or Python required (backend is Firebase BaaS)
|
||||
|
||||
### Development Environment Setup
|
||||
1. Fork the repository
|
||||
@@ -32,19 +35,15 @@ Thank you for your interest in contributing to the AI Study Assistant! This guid
|
||||
git clone https://github.com/YOUR_USERNAME/teachit.git
|
||||
cd teachit
|
||||
|
||||
# Install Flutter dependencies
|
||||
# Install Flutter dependencies only
|
||||
flutter pub get
|
||||
|
||||
# Install Node.js dependencies
|
||||
cd functions && npm install && cd ..
|
||||
|
||||
# Install Python dependencies
|
||||
cd rag_engine && pip install -r requirements.txt && cd ..
|
||||
# Note: No backend dependencies to install
|
||||
# No Cloud Functions (Firebase BaaS is used)
|
||||
# No Python RAG engine (implemented in Dart)
|
||||
|
||||
# Run tests
|
||||
flutter test
|
||||
npm test
|
||||
pytest tests/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user