FoxyChatFoxyChat

Installation

Set up FoxyChat on your system

FoxyChat Installation Guide

This guide will walk you through the process of installing and setting up FoxyChat, an all-in-one chat application built with Electron.

System Requirements

  • Operating System: macOS, Windows, or Linux
  • Node.js: Version 18.0.0 or higher
  • PNPM: Version 8.0.0 or higher
  • Disk Space: At least 500MB of free space

Installation Steps

1. Install Prerequisites

Node.js

Download and install Node.js from the official website. We recommend using the LTS version.

PNPM

After installing Node.js, install PNPM globally by running:

npm install -g pnpm

Verify the installation:

pnpm --version

2. Clone the Repository

git clone https://github.com/your-username/foxfoxy.git
cd foxfoxy

3. Install Dependencies

From the root directory, run:

pnpm install

This will install all dependencies for all packages in the workspace.

4. Configure Environment Variables

Navigate to the app directory:

cd app

Create a .env file based on the provided example:

cp .env.example .env

Edit the .env file and fill in the required credentials:

API_KEY=your_api_key_here

5. Start the Application

From the root directory:

pnpm start

Or if you're in the app directory:

pnpm start

Development Setup

Building for Development

To build the application for development:

cd app
pnpm run package

Running Tests

From the root directory:

pnpm test

To run end-to-end tests:

pnpm test:e2e

Troubleshooting

Common Issues

  1. PNPM command not found

    Ensure that PNPM is installed globally:

    npm install -g pnpm
  2. Node.js version conflict

    Use a Node version manager like nvm to install the correct Node.js version:

    nvm install 18
    nvm use 18
  3. Build errors

    Make sure you have the latest dependencies:

    pnpm install

Getting Help

If you encounter issues not covered here, please:

  1. Check the existing GitHub issues
  2. Create a new issue with detailed information about your problem

Next Steps

After installation, you might want to:

  1. Configure your chat providers
  2. Learn about the user interface
  3. Explore advanced features