Skip to main content

FishingLog Platform Documentation

Welcome to the comprehensive documentation for the FishingLog platform. This documentation covers the backend API, frontend applications, deployment, and all features of the platform.

🎯 Quick Links​

Getting Started​

API Documentation​

Deployment​

Features​

Infrastructure​

Reference​

Frontend Applications​

Testing​

📚 Documentation Structure​

Backend API​

The FishingLog Backend is an ASP.NET Core 9.0 REST API providing endpoints for:

  • Fishing logs, sessions, and catches
  • Social features (posts, comments, likes, friends)
  • Tournaments and registrations
  • Gear management
  • Spots, reports, and ratings
  • Admin panel and moderation
  • Advertising campaigns

Tech Stack:

  • ASP.NET Core 9.0
  • PostgreSQL 16
  • AWS Cognito (Authentication)
  • Docker & Docker Compose
  • AWS ECS (Deployment)

Frontend Applications​

Mobile App (React Native)​

Native mobile application for iOS and Android providing full access to FishingLog features on mobile devices.

Web Application​

Progressive web application for desktop and mobile browsers with responsive design.

Admin Panel​

Administrative interface for managing users, content moderation, tournaments, and platform analytics.

🚀 Quick Start​

  1. Clone the repository

    git clone <repository-url>
    cd FishingLog.Backend

  2. Set up local development

    # Start database
    docker-compose up -d db

    # Run migrations
    dotnet ef database update --project FishingLog.Infrastructure --startup-project FishingLog.API

    # Start API
    dotnet run --project FishingLog.API

  3. Access the API

    • API: https://localhost:5101
    • Swagger: https://localhost:5101/swagger

See Getting Started for detailed instructions.

📖 Documentation Sections​

Getting Started​

Complete setup guide for new developers, including prerequisites, installation, and first steps.

API Documentation​

Comprehensive API reference with all endpoints, authentication, request/response examples, and testing guides.

Deployment​

Deployment guides for staging and production environments, including AWS ECS setup, CI/CD configuration, and DNS management.

Features​

Detailed documentation for major platform features including implementation details, usage examples, and best practices.

Infrastructure​

Database schema, entity relationships, seeding strategies, and infrastructure architecture.

Reference​

Reference documentation for AWS services, security configurations, and platform-specific settings.

Frontend​

Documentation for frontend applications including React Native mobile app, web application, and admin panel.

Testing​

Testing guides and tools including Insomnia workspace setup and API testing strategies.

🔗 External Resources​

📝 Contributing​

This documentation is maintained alongside the codebase. When adding new features or making changes:

  1. Update relevant documentation files
  2. Add new documentation for new features
  3. Keep examples and code snippets up to date
  4. Test all documentation links and examples

Last Updated: December 2025
Version: 1.0.0