Getting Started

Welcome to FishingLog! This section will help you get up and running with the platform.

📋 Prerequisites

Before you begin, ensure you have the following installed:

• .NET SDK 9.0 or later (Download)
• Docker Desktop (Download)
• PostgreSQL 16 (optional if using Docker)
• AWS CLI (for deployment and Cognito management)
• Git

🚀 Quick Start Guide

1. Installation & Setup - Install dependencies and configure your environment
2. Local Development - Set up and run the API locally
3. Docker Setup - Run everything with Docker Compose

📚 Next Steps

After getting the application running:

• API Documentation - Learn about the API endpoints
• Testing Guide - Set up API testing with Insomnia
• Deployment Guide - Deploy to staging environment

🆘 Need Help?

• Check the Troubleshooting section below
• Review the Reference Documentation
• See the main README.md for project overview

---

Troubleshooting

Common Issues

Database connection fails

• Ensure PostgreSQL is running: docker-compose up -d db
• Check connection string in appsettings.json
• Verify database exists

HTTPS certificate errors

• Run: dotnet dev-certs https --trust
• Ensure certificate exists: ls ~/.aspnet/https/aspnetapp.pfx

Migrations fail

• Ensure database is running
• Check connection string
• Try: dotnet ef database update --project FishingLog.Infrastructure --startup-project FishingLog.API

Authentication fails

• Verify Cognito User Pool ID and Client ID in Program.cs
• Ensure user exists in Cognito (see Cognito Management)
• Check that USER_PASSWORD_AUTH flow is enabled in Cognito