Navigate event listings using natural language. This tool lets you ask questions about event data (from Google Sheets, CSV, or Excel) in plain English and get instant results.
- Connect to Google Sheets via URL.
- Upload CSV, XLS, or XLSX files.
- Ask natural language questions about your data.
- View results in an easy-to-read table.
- Export results to CSV (Coming soon!).
- Simple, clean interface.
- Frontend: React, TypeScript, Vite, CSS
- Core Logic: (Potentially add backend language/framework if applicable, e.g., Python/Flask/FastAPI)
- AI/LLM: (Specify the model or service used for NLQ processing, e.g., OpenAI API)
- Libraries:
papaparse,xlsx,lucide-react
-
Clone the repository:
git clone https://github.com/IdeaFlowCo/EventNavigator.git cd EventNavigator -
Set up Frontend:
cd frontend npm install -
Environment Variables:
- Navigate to the
frontenddirectory. - Copy the example environment file:
cp .env.example .env - Edit the
.envfile and add any necessary API keys or configuration (e.g.,VITE_OPENAI_API_KEY=your_api_key_hereif using OpenAI).
- Navigate to the
-
Run the Frontend Development Server:
npm run dev
The application should now be running, typically at
http://localhost:5173.
- Provide Event Data: Either paste a Google Sheet URL (ensure it's publicly accessible or you have permission) containing event listings or upload a CSV/Excel file.
- Ask a Question: Type your question about the events in the input box (e.g., "show me all sound camps near 9:00 & Esplanade", "what events are happening on Tuesday night?", "find workshops related to sustainability").
- Get Results: Click "Go". BRC Navigator will process the event data and your question, displaying the relevant results in a table below.
Contributions are welcome! Please feel free to submit issues or pull requests.
This project is licensed under the MIT License - see the LICENSE file for details.