Files
ocean-cleanup/server
Paul Bailey d91a13da60 feat: implement analytics endpoints (task 28)
- Created analytics service with summary, trends, comparison, and aggregated data methods
- Implemented 5 analytics endpoints: summary, trends, comparison, aggregated, and CSV export
- Added time series data with day/week/month interval support
- Implemented period-over-period comparison metrics with percentage changes
- Added CSV export functionality using json2csv
- Updated frontend analytics service to unwrap API responses
- Fixed chart components to work with new data structure (reportCount, eventCount, litterCollected)
- Updated TypeScript types to match backend API structure
- All endpoints tested and verified working

Requirements satisfied: 5.1, 5.2, 5.3, 5.4, 5.5
2025-11-17 00:13:07 +00:00
..

Beach Litter Mapping API

Backend API server for the Beach Litter Mapping Platform.

Setup

  1. Install dependencies:
cd server
npm install
  1. Configure environment variables:
cp .env.example .env
# Edit .env with your configuration
  1. Set up the database:
npm run prisma:generate
npm run prisma:migrate
  1. Start the development server:
npm run dev

The API will be available at http://localhost:3000

API Endpoints

Reports

  • POST /api/reports/upload - Upload a photo (requires auth)
  • POST /api/reports - Create a new report (requires auth)
  • GET /api/reports - Get all reports (with optional filters)
  • GET /api/reports/:id - Get a single report
  • DELETE /api/reports/:id - Delete a report (requires auth, owner only)

Health Check

  • GET /health - Server health status

Environment Variables

See .env.example for required environment variables.

Database

The API uses MySQL 8.0+ with Prisma ORM. Connection details are configured in the .env file.

Authentication

Authentication is handled by Clerk. Protected endpoints require a Bearer token in the Authorization header.