Customer-Engagement-Platform

Planning documents:

• Norwa Water Portal Revised Specification - phase-one scope with ERPNext GET-only integration and portal-side customer service workflows.

Project Structure

• backend/ - FastAPI API, PostgreSQL persistence, ERPNext GET-only integration layer, portal request workflow backend.
• frontend/ - Vue 3 + Vite customer service operations interface.

Backend layout:

• backend/app/api/v1/routes/ - route handlers grouped by API version.
• backend/app/services/ - business logic grouped by domain.
• backend/app/models/ - SQLAlchemy models.
• backend/app/schemas/ - Pydantic schemas.
• backend/app/dependencies/ - authentication and permission dependencies.

Backend plan:

• Backend Development Plan
• Backend API Usage

Local Development

PostgreSQL:

docker compose up -d postgres

The Docker database is available to the backend on 127.0.0.1:55432.

Backend:

cd backend
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env
alembic upgrade head
uvicorn app.main:app --reload

Frontend:

cd frontend
npm install
cp .env.example .env
npm run dev