Skip to content

Instantly share code, notes, and snippets.

@ruvnet
Created May 2, 2024 14:14
Show Gist options
  • Save ruvnet/290fcc94a40372918e72b0759f3c9ebb to your computer and use it in GitHub Desktop.
Save ruvnet/290fcc94a40372918e72b0759f3c9ebb to your computer and use it in GitHub Desktop.
Omniplex - Open Source Perplexity Clone Installation Instructions

Omniplex - Open Source Perplexity Clone Installation Instructions

Prerequisites

  • Node.js (v14 or later)
  • npm (comes bundled with Node.js)
  • Firebase account (for authentication and data storage)

Setup

  1. Clone the repository:

    git clone https://github.com/Omniplex-ai/omniplex.git
  2. Navigate to the project directory:

    cd omniplex
  3. Install dependencies:

    npm install
  4. Create a .env.local file in the project root directory and add your Firebase configuration:

    NEXT_PUBLIC_FIREBASE_API_KEY=your-api-key
    NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your-auth-domain
    NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id
    NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your-storage-bucket
    NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your-messaging-sender-id
    NEXT_PUBLIC_FIREBASE_APP_ID=your-app-id
    

    Replace the placeholders with your actual Firebase project configuration values.

  5. Run the development server:

    npm run dev

    The application should now be running at http://localhost:3000.

Build for Production

To create a production build, run:

npm run build

Then, you can start the production server with:

npm start

Additional Configuration

API Keys

You may need to obtain API keys for various services used in the application (e.g., OpenAI, Anthropic, Google Search). Follow the instructions provided in the respective service documentation to obtain the keys and add them to the appropriate configuration files or environment variables.

Firebase Configuration

Ensure that you have properly configured Firebase for authentication and data storage. Refer to the Firebase documentation for more details on setting up and configuring Firebase for your project.

Support

If you encounter any issues or have questions, please check the documentation or join our Discord server for support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment