# Development Setup This document describes how to set up a development environment for the Email Organizer application. ## Prerequisites - Docker and Docker Compose - Python 3.10+ ## Services The development environment consists of two services: 1. **PostgreSQL Database**: A non-persistent PostgreSQL instance for development 2. **IMAP Server**: A fake IMAP server with predefined users and folders ## Setup Commands To set up the development environment, run: ```bash flask setup-dev ``` This command will: 1. Create necessary directories 2. Start PostgreSQL and IMAP services via Docker Compose 3. Display connection information ## Service Details ### PostgreSQL - Host: localhost - Port: 5432 - Database: email_organizer_dev - User: postgres - Password: password ### IMAP Server - Host: localhost - Port: 1143 - Users: - user1@example.com / password1 - user2@example.com / password2 - Folders: - INBOX - Pending - Work - Personal - Receipts - Marketing - Archived ## Environment Configuration After running `flask setup-dev`, copy the example environment file: ```bash cp .env.example .env ``` The default configuration should work with the development services. You can modify the `.env` file if needed.