Skip to content

Latest commit

 

History

History
116 lines (83 loc) · 2.56 KB

README.md

File metadata and controls

116 lines (83 loc) · 2.56 KB

Perplexity Web UI

A modern web interface for interacting with the Perplexity AI API, built with React, TypeScript, and Tailwind CSS.

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 18 or higher)
  • npm (comes with Node.js)
  • A Perplexity API key

Installation

Windows

  1. Open PowerShell or Command Prompt and run:
# Clone the repository
git clone https://github.com/PierrunoYT/perplexity-webui.git

# Navigate to project directory
cd perplexity-webui

# Install dependencies
npm install
  1. Create a .env file in the root directory:
VITE_PERPLEXITY_API_KEY=your_api_key_here
  1. Start the development server:
npm run dev

macOS/Linux

  1. Open Terminal and run:
# Clone the repository
git clone https://github.com/PierrunoYT/perplexity-webui.git

# Navigate to project directory
cd perplexity-webui

# Install dependencies
npm install

# Create .env file
echo "VITE_PERPLEXITY_API_KEY=your_api_key_here" > .env

# Start development server
npm run dev

Building for Production

To build and preview the production version:

# Build the project
npm run build

# Preview the build
npm run preview

Features

  • 🌙 Dark/Light mode support
  • 💬 Real-time chat interface
  • ⚙️ Customizable API settings
  • 📊 Structured output support
  • 🔍 Related questions suggestions
  • 📝 Markdown rendering with citation support
  • 🌐 Cross-platform compatibility

Development

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint

Project Structure

perplexity-webui/
├── src/
│   ├── components/     # React components
│   ├── services/      # API and other services
│   ├── App.tsx        # Main application component
│   └── main.tsx       # Application entry point
├── public/            # Static assets
└── package.json       # Project dependencies and scripts

License

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

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Support

If you encounter any issues or have questions, please open an issue on GitHub.