lumely-next
v0.1.20
Published
AI-powered error handling for Next.js applications
Maintainers
Readme
lumely-next
AI-powered error handling for Next.js applications. Automatically catches errors, explains them to users in plain language then provides developers with error notification and fix suggestions.
Installation
npm install lumely-nextQuick Start
Just wrap your app with LumelyProvider and add your API key:
// pages/_app.tsx
import { LumelyProvider } from 'lumely-next';
export default function App({ Component, pageProps }) {
return (
<LumelyProvider
apiKey={process.env.NEXT_PUBLIC_LUMELY_API_KEY ?? ''}
>
<Component {...pageProps} />
</LumelyProvider>
);
}That's it! Lumely will automatically:
- Catch errors and display a user-friendly overlay
- Send error data to Lumely's hosted backend
- Generate AI-powered explanations and fix suggestions
- Store errors in your Lumely dashboard
Get Your API Key
- Sign up at lumely.vercel.app
- Create a project
- Copy your API key from the project settings
Features
- AI-Powered Explanations - Errors are explained in plain language
- User Feedback - Collect context about what users were doing
- Modern Glassmorphism UI - Beautiful overlay with Poppins font
- Fast Response - User message appears in ~2s, detailed analysis runs in background
- Zero Config - Works out of the box with Lumely's hosted backend
Props
| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| apiKey | string | Yes | - | Your Lumely API key |
| environment | 'development' | 'production' | No | 'production' | Current environment |
| userId | string | No | - | Optional user identifier |
Manual Error Reporting
Report caught errors that don't crash the app:
import { useLumelyReport } from 'lumely-next';
function MyComponent() {
const { reportError } = useLumelyReport();
const handleClick = async () => {
try {
await fetch('/api/action');
} catch (error) {
reportError(error, { action: 'button_click' });
}
};
return <button onClick={handleClick}>Action</button>;
}Documentation
Visit lumely.vercel.app/docs for full documentation.
License
MIT
