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:
Verify the installation:
2. Clone the Repository
3. Install Dependencies
From the root directory, run:
This will install all dependencies for all packages in the workspace.
4. Configure Environment Variables
Navigate to the app directory:
Create a .env
file based on the provided example:
Edit the .env
file and fill in the required credentials:
5. Start the Application
From the root directory:
Or if you're in the app directory:
Development Setup
Building for Development
To build the application for development:
Running Tests
From the root directory:
To run end-to-end tests:
Troubleshooting
Common Issues
-
PNPM command not found
Ensure that PNPM is installed globally:
-
Node.js version conflict
Use a Node version manager like nvm to install the correct Node.js version:
-
Build errors
Make sure you have the latest dependencies:
Getting Help
If you encounter issues not covered here, please:
- Check the existing GitHub issues
- Create a new issue with detailed information about your problem
Next Steps
After installation, you might want to: