React with Vite

Vite’s approach to building React applications can introduce unique considerations when integrating Para. This guide addresses frequent issues and offers tailored solutions to ensure a successful implementation.

Using an LLM (ChatGPT, Claude) or Coding Assistant (Cursor, Github Copilot)? Here are a few tips:

Include the Para LLM-optimized context file to ensure you’re getting the most up-to-date help!
Check out the Example Hub Wiki for an interactive LLM that leverages the Para Examples Hub!

General Troubleshooting Steps

Before diving into specific issues, try these general troubleshooting steps:

Clear cache and node_modules

bash rm -rf node_modules npm cache clean --force

Reinstall dependencies

bash npm install

Update Para-related packages

bash npm update @getpara/react-sdk

Rebuild the project

bash npm run build

Common Issues and Solutions

Missing Node.js Polyfills

Problem: Vite doesn’t include Node.js polyfills by default, which can cause issues with packages that depend on Node.js built-ins like buffer or crypto.

Solution: Add the necessary polyfills using the vite-plugin-node-polyfills plugin. Adjust the configuration as needed for your specific requirements:

Install the plugin:

npm install --save-dev vite-plugin-node-polyfills

Update your vite.config.js:

import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
import { nodePolyfills } from "vite-plugin-node-polyfills";

export default defineConfig({
  plugins: [
    react(),
    nodePolyfills({
      include: ["buffer", "crypto", "stream", "util"],
    }),
  ],
  // ... other configurations
});

Environment Variables Not Accessible

Problem: Environment variables not being recognized in your application.

Solution: Ensure you’re prefixing your environment variables with VITE_ and accessing them correctly:

In your .env file:
```
VITE_PARA_API_KEY=your_api_key_here
```

In your code:

const para = new Para(Environment.BETA, import.meta.env.VITE_PARA_API_KEY);

CSS Loading Issues

Problem: Para’s CSS files not loading correctly.

Solution: Import Para’s CSS file in your main App.jsx or index.jsx:

import "@getpara/react-sdk/dist/index.css";

function App() {
  // Your app code
}

export default App;

Best Practices

Use the Latest Versions: Always use the latest versions of Vite, React, and Para SDK to ensure compatibility and access to the latest features.
Error Handling: Implement error boundaries to gracefully handle any runtime errors related to Para integration.
Development vs Production: Use environment-specific configurations to manage different settings for development and production builds. Para provides environment-specific API keys.

By following these troubleshooting steps and best practices, you should be able to resolve most common issues when integrating Para with your React application using Vite.

Integration Support

If you’re experiencing issues that aren’t resolved by our troubleshooting resources, please contact our team for assistance. To help us resolve your issue quickly, please include the following information in your request:

1
A detailed description of the problem you’re encountering.
2
Any relevant error messages or logs.
3
Steps to reproduce the issue.
4
Details about your system or environment (e.g., device, operating system, software version).

Providing this information will enable our team to address your concerns more efficiently.

Introduction

Setup

Guides

API & Troubleshooting

General Troubleshooting Steps

Common Issues and Solutions

Best Practices

Integration Support

Introduction

Setup

Guides

API & Troubleshooting

​General Troubleshooting Steps

​Common Issues and Solutions

​Best Practices

​Integration Support

General Troubleshooting Steps

Common Issues and Solutions

Best Practices

Integration Support