{"id":26356064,"url":"https://github.com/devehab/dream-interpretation","last_synced_at":"2026-05-10T10:19:24.190Z","repository":{"id":276590471,"uuid":"897772894","full_name":"Devehab/dream-interpretation","owner":"Devehab","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-07T01:14:07.000Z","size":27926,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-07T01:34:36.308Z","etag":null,"topics":["ai","artificial-intelligence","flask","flask-api","flask-application","gemini-ai","openai","python","python3"],"latest_commit_sha":null,"homepage":"https://dream-saas.onrender.com","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Devehab.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-03T08:05:47.000Z","updated_at":"2025-03-07T01:14:10.000Z","dependencies_parsed_at":"2025-02-09T09:20:41.339Z","dependency_job_id":"75b80c20-5b7d-4b99-8a93-14ed82cdc898","html_url":"https://github.com/Devehab/dream-interpretation","commit_stats":null,"previous_names":["devehab/dream-interpretation"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devehab%2Fdream-interpretation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devehab%2Fdream-interpretation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devehab%2Fdream-interpretation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Devehab%2Fdream-interpretation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Devehab","download_url":"https://codeload.github.com/Devehab/dream-interpretation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243871884,"owners_count":20361380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","artificial-intelligence","flask","flask-api","flask-application","gemini-ai","openai","python","python3"],"created_at":"2025-03-16T13:19:04.142Z","updated_at":"2026-05-10T10:19:19.160Z","avatar_url":"https://github.com/Devehab.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ✨ Dream Interpretation\n\n![Python](https://img.shields.io/badge/Python-3.8%2B-blue)\n![Flask](https://img.shields.io/badge/Flask-2.0+-blue)\n![AI](https://img.shields.io/badge/AI-Machine%20Learning-orange)\n![Gemini](https://img.shields.io/badge/Gemini-Google%20AI-red)\n\n## 🌐 Live Demo\n\nYou can try the application here: [Dream Interpretation on Render](https://dream-saas.onrender.com)\n\n⚠ **Note:** This application is hosted on a free server, which may enter sleep mode when not in use. The first request might take a few seconds to wake up the server.\n\n## 📖 Description\n\nDream Interpretation is an AI-powered project that analyzes and interprets dreams based on user inputs. The project aims to provide instant and comprehensive interpretations, helping users gain a deeper understanding of their dreams.\n\n## 🚀 Features\n\n- ⚡ **Instant Analysis:** Provides immediate dream interpretations.\n- 🤖 **AI-Powered:** Uses machine learning models for accurate dream analysis.\n- 🎨 **User-Friendly Interface:** Easy-to-use design for dream input and interpretation.\n\n## 🛠️ Installation\n\n### 📌 Prerequisites\n\nBefore installing, ensure you have the required dependencies:\n\n1. **Check if Python is installed:**\n\n   ```bash\n   python3 --version\n   ```\n\n   If Python is not installed, you can install it using the terminal:\n\n   **For Ubuntu/Debian:**\n\n   ```bash\n   sudo apt update \u0026\u0026 sudo apt install python3\n   ```\n\n   **For macOS (using Homebrew):**\n\n   If Homebrew is not installed, install it using:\n\n   ```bash\n   /bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n   ```\n\n   ```bash\n   brew install python3\n   ```\n\n   **For Windows:**\n   Download and install it from [Python's official site](https://www.python.org/downloads/), then ensure `python3` is added to your system PATH.\n\n2. **Check if pip is installed:**\n\n   ```bash\n   pip3 --version\n   ```\n\n   If pip is missing, install it using:\n\n   ```bash\n   python3 -m ensurepip --default-pip\n   ```\n\n3. **Ensure Git is installed:**\n\n   ```bash\n   git --version\n   ```\n\n   If Git is not installed, follow the instructions on [Git's official website](https://git-scm.com/downloads).\n\n4. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/Devehab/dream-interpretation.git\n   cd dream-interpretation\n   ```\n\n5. **Obtain a Google API Key:**\n\n   - Visit [Google AI Studio](https://aistudio.google.com/).\n   - Sign in with your Google account.\n   - Navigate to the API section and generate a new API key.\n   - Copy the generated API key.\n\n6. **Create a ************************`.env`************************ file and store the API key:**\n\n   - Open a terminal inside the project directory.\n   - In the terminal, navigate to your project directory and run the following command to create the `.env` file:\n     ```bash\n     touch .env\n     ```\n   - Open the `.env` file with a text editor and add the following line:\n     ```\n     GOOGLE_API_KEY=your-api-key-here\n     ```\n   - Save and close the file.\n\n7. **Create and activate a virtual environment:**\n\n   ```bash\n   python3 -m venv venv\n   source venv/bin/activate\n   ```\n\n8. **Install dependencies:**\n\n   ```bash\n   pip3 install -r requirements.txt\n   ```\n\n9. **Run the application locally:**\n\n   ```bash\n   python3 app.py\n   ```\n\n## 🚀 Deploying to a Live Server (Render)\n\nYou can deploy this application on a live server like **Render** by following these steps:\n\n1. **Create a Render account:**\n\n   - Go to [Render](https://render.com/) and sign up.\n\n2. **Create a new web service:**\n\n   - Click on \"New\" -\u003e \"Web Service\".\n   - Connect your GitHub repository and select `dream-interpretation`.\n   - Choose the `Python` runtime and configure the environment.\n\n3. **Set up environment variables:**\n\n   - In the Render dashboard, go to the \"Environment\" section.\n   - Add `GOOGLE_API_KEY` with your API key.\n\n4. **Define the start command:**\n\n   ```bash\n   gunicorn -w 4 -b 0.0.0.0:3000 app:app\n   ```\n\n5. **Deploy and monitor:**\n\n   - Click \"Deploy\" and wait for the build to complete.\n   - Your application will be live at the provided Render URL.\n\n## 🎯 Usage\n\nOnce the application is running, open a web browser and go to `http://127.0.0.1:3000` or the deployed Render URL. Enter your dream description and click the \"Interpret\" button to receive an analysis.\n\n## 🐳 Docker Deployment\n\n### 🚀 Option 1: Quick Start with Docker Compose\n\nThe fastest way to get up and running:\n\n```bash\n# Create a directory for the application\nmkdir dream-interpretation\ncd dream-interpretation\n\n# Download only the compose.yml file from GitHub\ncurl -O https://raw.githubusercontent.com/Devehab/dream-interpretation/main/compose.yml\n\n# Edit the compose.yml file to add your Google API key\n# Replace 'your_api_key' with your actual Google API key\n\n# Run with Docker Compose\ndocker compose up -d\n```\n\n\u003e This will pull the pre-built image from Docker Hub and start the application with all necessary configurations.\n\u003e Access the application at: http://localhost:3000\n\n### 🛠️ Option 2: Manual Docker Setup\n\n#### Step 1: Build the Docker Image\n\n**For Single Architecture:**\n```bash\ndocker build -t dream-interpretation .\n```\n\n**For Multiple Architectures (AMD64 \u0026 ARM64):**\n```bash\n# Create and use a buildx builder\ndocker buildx create --use\n\n# Build and push the multi-architecture image\n# Replace 'yourusername' with your Docker Hub username\ndocker buildx build --platform linux/amd64,linux/arm64 -t yourusername/dream-interpretation:latest --push .\n```\n\n\u003e This builds the image for both AMD64 (standard servers) and ARM64 (Mac M1/M2, Raspberry Pi) architectures.\n\u003e The `--push` flag uploads the image to Docker Hub. Remove it if you only want to build locally.\n\n#### Step 2: Run the Container\n\n**Using environment variable directly:**\n```bash\ndocker run -d -p 3000:3000 -e GOOGLE_API_KEY=your_api_key dream-interpretation\n```\n\n**Or using .env file:**\n```bash\ndocker run -d -p 3000:3000 --env-file .env dream-interpretation\n```\n\n#### Step 3: Access the Application\nOpen your browser and navigate to `http://localhost:3000`\n\n### 📋 Useful Docker Commands\n\n```bash\n# View running containers\ndocker ps\n\n# Stop the container\ndocker stop \u003ccontainer_id\u003e\n\n# Remove the container\ndocker rm \u003ccontainer_id\u003e\n```\n\n## 🤝 Contributing\n\nWe welcome contributions! To contribute:\n\n1. **Fork the repository** by clicking on the \"Fork\" button at the top right.\n2. **Create a new branch:**\n   ```bash\n   git checkout -b feature/your-feature-name\n   ```\n3. **Make your changes and commit them.**\n4. **Push the changes:**\n   ```bash\n   git push origin feature/your-feature-name\n   ```\n5. **Create a Pull Request** on the original repository.\n\n## 📜 License\n\nThis project is licensed under the MIT License. For more details, see the [LICENSE](LICENSE) file.\n\n---\n\n🚀 *Feel free to open issues or discussions for suggestions and improvements!*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevehab%2Fdream-interpretation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevehab%2Fdream-interpretation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevehab%2Fdream-interpretation/lists"}