Repository files navigation

Lunaris is an innovative platform that uses AI to generate viral video clips from long-form content. This repository contains both the frontend and backend components of the application.

To get started with Lunaris, clone the repository:

git clone https://github.com/savnani5/Lunaris.gitcd Lunaris

• Frontend
  • Prerequisites
  • Installation
  • Environment Setup
  • Running the Frontend
• Backend
  • Prerequisites
  • Installation
  • Environment Setup
  • Running the Backend
  • Docker Setup
  • Conda Environment Setup

• Node.js (v14 or later)
• npm (v6 or later)

1. Navigate to the frontend directory:

   cd Lunaris/frontend

2. Install dependencies:

   npm install

1. Create a.env.local file in thefrontend directory:

   touch .env.local

2. Add the following environment variables to.env.local:

   # ClerkNEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_keyCLERK_SECRET_KEY=your_clerk_secret_keyNEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-inNEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up# MongoDBMONGODB_URI=your_mongodb_uri# Backend URLNEXT_PUBLIC_BACKEND_URL=backend_url# YouTube API KeyYT_API_KEY=your_youtube_api_key

   Replace the placeholders with your actual credentials and settings.

1. Start the development server:

   npm run dev

2. Open your browser and navigate tohttp://localhost:3000

• Python 3.11 or later
• pip
• FFmpeg
• ImageMagick

1. Navigate to the backend directory:

   cd Lunaris/backend

2. Install dependencies:

   pip install -r requirements.txt

1. Create a.env file in thebackend directory:

   touch .env

2. Add the following environment variables to.env:

   FLASK_ENV=developmentMONGODB_URI=your_mongodb_uriAWS_ACCESS_KEY_ID=your_aws_access_keyAWS_SECRET_ACCESS_KEY=your_aws_secret_keyAWS_REGION=your_aws_regionS3_BUCKET_NAME=your_s3_bucket_nameOPENAI_API_KEY=your_openai_api_keyDG_API_KEY=your_deepgram_api_key

   Replace the placeholders with your actual credentials and settings.

1. Start the Flask development server:

   python app.py

   The server will start onhttp://localhost:5001

To run the backend using Docker:

1. Build the Docker image:

   docker build -t lunaris-backend .

2. Run the Docker container:

   docker run -p 8080:8080 --env-file .env lunaris-backend

   The server will be accessible athttp://localhost:8080

To set up a Conda environment for the backend:

1. Create a new Conda environment:

   conda create -n lunaris python=3.11

2. Activate the environment:

   conda activate lunaris

3. Install Python dependencies:

   pip install -r requirements.txt

4. Install system dependencies:

   FFmpeg and ImageMagick are system-level dependencies. The installation method depends on your operating system:

   • On Ubuntu/Debian:

     sudo apt-get updatesudo apt-get install ffmpeg imagemagick

   • On macOS (using Homebrew):

     brew install ffmpeg imagemagick

   • On Windows:Download and install FFmpeg fromhttps://ffmpeg.org/download.htmlDownload and install ImageMagick fromhttps://imagemagick.org/script/download.php

   Alternatively, if you prefer using Conda for these dependencies:

   conda install -c conda-forge ffmpeg imagemagick

   Note: Using Conda for system packages may not always be ideal for production environments.

5. Run the backend server:

   python app.py

• The frontend is built with Next.js and uses Tailwind CSS for styling.
• The backend uses Flask and integrates with various AI services for video processing.
• Make sure to set up the necessary cloud services (MongoDB, AWS S3, OpenAI, Deepgram) before running the application.
• For production deployment, consider using a process manager like PM2 for the backend and a production-ready server for the frontend.

Please read ourContributing Guidelines for details on our code of conduct and the process for submitting pull requests.

This project is licensed under the MIT License - see theLICENSE file for details.