https://github.com/devehab/dream-interpretation
https://github.com/devehab/dream-interpretation
ai artificial-intelligence flask flask-api flask-application gemini-ai openai python python3
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/devehab/dream-interpretation
- Owner: Devehab
- License: gpl-3.0
- Created: 2024-12-03T08:05:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-07T01:14:07.000Z (over 1 year ago)
- Last Synced: 2025-03-07T01:34:36.308Z (over 1 year ago)
- Topics: ai, artificial-intelligence, flask, flask-api, flask-application, gemini-ai, openai, python, python3
- Language: HTML
- Homepage: https://dream-saas.onrender.com
- Size: 26.6 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨ Dream Interpretation
## 🌐 Live Demo
You can try the application here: [Dream Interpretation on Render](https://dream-saas.onrender.com)
⚠ **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.
## 📖 Description
Dream 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.
## 🚀 Features
- ⚡ **Instant Analysis:** Provides immediate dream interpretations.
- 🤖 **AI-Powered:** Uses machine learning models for accurate dream analysis.
- 🎨 **User-Friendly Interface:** Easy-to-use design for dream input and interpretation.
## 🛠️ Installation
### 📌 Prerequisites
Before installing, ensure you have the required dependencies:
1. **Check if Python is installed:**
```bash
python3 --version
```
If Python is not installed, you can install it using the terminal:
**For Ubuntu/Debian:**
```bash
sudo apt update && sudo apt install python3
```
**For macOS (using Homebrew):**
If Homebrew is not installed, install it using:
```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
```bash
brew install python3
```
**For Windows:**
Download and install it from [Python's official site](https://www.python.org/downloads/), then ensure `python3` is added to your system PATH.
2. **Check if pip is installed:**
```bash
pip3 --version
```
If pip is missing, install it using:
```bash
python3 -m ensurepip --default-pip
```
3. **Ensure Git is installed:**
```bash
git --version
```
If Git is not installed, follow the instructions on [Git's official website](https://git-scm.com/downloads).
4. **Clone the repository:**
```bash
git clone https://github.com/Devehab/dream-interpretation.git
cd dream-interpretation
```
5. **Obtain a Google API Key:**
- Visit [Google AI Studio](https://aistudio.google.com/).
- Sign in with your Google account.
- Navigate to the API section and generate a new API key.
- Copy the generated API key.
6. **Create a ************************`.env`************************ file and store the API key:**
- Open a terminal inside the project directory.
- In the terminal, navigate to your project directory and run the following command to create the `.env` file:
```bash
touch .env
```
- Open the `.env` file with a text editor and add the following line:
```
GOOGLE_API_KEY=your-api-key-here
```
- Save and close the file.
7. **Create and activate a virtual environment:**
```bash
python3 -m venv venv
source venv/bin/activate
```
8. **Install dependencies:**
```bash
pip3 install -r requirements.txt
```
9. **Run the application locally:**
```bash
python3 app.py
```
## 🚀 Deploying to a Live Server (Render)
You can deploy this application on a live server like **Render** by following these steps:
1. **Create a Render account:**
- Go to [Render](https://render.com/) and sign up.
2. **Create a new web service:**
- Click on "New" -> "Web Service".
- Connect your GitHub repository and select `dream-interpretation`.
- Choose the `Python` runtime and configure the environment.
3. **Set up environment variables:**
- In the Render dashboard, go to the "Environment" section.
- Add `GOOGLE_API_KEY` with your API key.
4. **Define the start command:**
```bash
gunicorn -w 4 -b 0.0.0.0:3000 app:app
```
5. **Deploy and monitor:**
- Click "Deploy" and wait for the build to complete.
- Your application will be live at the provided Render URL.
## 🎯 Usage
Once 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.
## 🐳 Docker Deployment
### 🚀 Option 1: Quick Start with Docker Compose
The fastest way to get up and running:
```bash
# Create a directory for the application
mkdir dream-interpretation
cd dream-interpretation
# Download only the compose.yml file from GitHub
curl -O https://raw.githubusercontent.com/Devehab/dream-interpretation/main/compose.yml
# Edit the compose.yml file to add your Google API key
# Replace 'your_api_key' with your actual Google API key
# Run with Docker Compose
docker compose up -d
```
> This will pull the pre-built image from Docker Hub and start the application with all necessary configurations.
> Access the application at: http://localhost:3000
### 🛠️ Option 2: Manual Docker Setup
#### Step 1: Build the Docker Image
**For Single Architecture:**
```bash
docker build -t dream-interpretation .
```
**For Multiple Architectures (AMD64 & ARM64):**
```bash
# Create and use a buildx builder
docker buildx create --use
# Build and push the multi-architecture image
# Replace 'yourusername' with your Docker Hub username
docker buildx build --platform linux/amd64,linux/arm64 -t yourusername/dream-interpretation:latest --push .
```
> This builds the image for both AMD64 (standard servers) and ARM64 (Mac M1/M2, Raspberry Pi) architectures.
> The `--push` flag uploads the image to Docker Hub. Remove it if you only want to build locally.
#### Step 2: Run the Container
**Using environment variable directly:**
```bash
docker run -d -p 3000:3000 -e GOOGLE_API_KEY=your_api_key dream-interpretation
```
**Or using .env file:**
```bash
docker run -d -p 3000:3000 --env-file .env dream-interpretation
```
#### Step 3: Access the Application
Open your browser and navigate to `http://localhost:3000`
### 📋 Useful Docker Commands
```bash
# View running containers
docker ps
# Stop the container
docker stop
# Remove the container
docker rm
```
## 🤝 Contributing
We welcome contributions! To contribute:
1. **Fork the repository** by clicking on the "Fork" button at the top right.
2. **Create a new branch:**
```bash
git checkout -b feature/your-feature-name
```
3. **Make your changes and commit them.**
4. **Push the changes:**
```bash
git push origin feature/your-feature-name
```
5. **Create a Pull Request** on the original repository.
## 📜 License
This project is licensed under the MIT License. For more details, see the [LICENSE](LICENSE) file.
---
🚀 *Feel free to open issues or discussions for suggestions and improvements!*