Update README.md with project overview, tech stack, installation instructions, and API documentation

Author: luisgs7

README.md

@@ -1 +1,129 @@
-# MiBook-Server
+# 📚 MiBook-Server
+
+A modern RESTful API server built with FastAPI for managing family recipes and cookbook collections.
+
+## 🚀 Tech Stack
+
+- **FastAPI** - Modern, fast web framework for building APIs
+- **PostgreSQL** - Powerful relational database
+- **Redis** - In-memory cache for improved performance
+- **Docker** - Containerization for easy deployment
+- **Python 3.13** - Latest Python version
+
+## 📋 Prerequisites
+
+Before running this project, make sure you have installed:
+
+- 🐳 [Docker](https://www.docker.com/get-started) (version 20.10 or higher)
+- 🐳 [Docker Compose](https://docs.docker.com/compose/install/) (version 2.0 or higher)
+
+## 🛠️ Installation & Setup
+
+1. **Clone the repository**
+   ```bash
+   git clone <repository-url>
+   cd MiBook-Server
+   ```
+
+## 🚀 Running the Project
+
+### Using Docker Compose (Recommended)
+
+1. **Start all services**
+   ```bash
+   docker-compose up --build
+   ```
+
+2. **The API will be available at:**
+   - 🌐 API: http://localhost:8000
+   - 📊 Interactive API Docs: http://localhost:8000/docs
+   - 📚 Alternative API Docs: http://localhost:8000/redoc
+
+3. **Stop the services**
+   ```bash
+   docker-compose down
+   ```
+
+### Running in Development Mode
+
+The project is configured to run in development mode with hot-reload enabled. Any changes you make to the code will automatically restart the server.
+
+## 📦 Services
+
+The project includes three main services:
+
+| Service | Port | Description |
+|---------|------|-------------|
+| 🚀 **API** | 8000 | FastAPI application server |
+| 🗄️ **PostgreSQL** | 5432 | Database server |
+| ⚡ **Redis** | 6379 | Cache server |
+
+## 🗂️ Project Structure
+
+```
+MiBook-Server/
+├── src/
+│   ├── main.py          # FastAPI application entry point
+│   └── ...
+├── db-data/             # PostgreSQL data (auto-generated)
+├── docker-compose.yml   # Docker services configuration
+├── Dockerfile           # API service container configuration
+├── requirements.txt     # Python dependencies
+└── README.md           # Project documentation
+```
+
+## 🔧 Development
+
+### Running Tests
+
+```bash
+docker-compose exec api pytest
+```
+
+### Code Formatting
+
+```bash
+docker-compose exec api black .
+```
+
+### Linting
+
+```bash
+docker-compose exec api flake8
+```
+
+## 🌍 Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `DB_HOST` | db | Database host |
+| `DB_NAME` | family_recipes | Database name |
+| `DB_USER` | postgres | Database user |
+| `DB_PASS` | postgres | Database password |
+| `DB_PORT` | 5432 | Database port |
+| `DEBUG` | - | Enable debug mode |
+| `SECRET_KEY` | - | Application secret key |
+| `ALLOWED_HOSTS` | - | Allowed hosts for CORS |
+
+## 📝 API Endpoints
+
+- `GET /` - Welcome message
+- `GET /docs` - Swagger UI documentation
+- `GET /redoc` - ReDoc documentation
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+This project is licensed under the terms specified in the LICENSE file.
+
+## 👤 Author
+
+**Luis Silva**
+- Email: luisgsilva26@gmail.com
+
+---
+
+Made with ❤️ using FastAPI