Skip to content

dayview/beacon

Repository files navigation

Beacon

A native usability testing and analytics platform built as a Miro application. It enables UX researchers and designers to overlay real-time heatmaps directly on Miro boards and gain AI-powered insights from user interaction data, all without leaving their design workflow.

TypeScript React Vite Tailwind CSS

Prerequisites

Getting Started

  1. Clone the repository:
git clone https://github.com/dayview/beacon.git
cd beacon

Install dependencies

npm install
# or
pnpm install

Start the development server

npm run dev

The app will be available a http://localhost:5173 by default.

Scripts

Command Description
npm run dev Starts the local development server
npm run build Builds the app for production
npm run preview Previews the production build locally
npm run lint Runs ESLint for code quality checks

Project Structure

beacon/
├── src/
│   ├── app/                  # Main application component
│   │   ├── App.tsx           # Root component with routing logic
│   │   └── components/       # App-specific components
│   ├── components/           # Shared/reusable UI components
│   ├── screens/              # Main application screens
│   │   ├── Dashboard.tsx
│   │   ├── LiveAnalytics.tsx
│   │   └── Comparison.tsx
│   ├── lib/                  # Utility functions and helpers
│   ├── styles/               # Global styles and fonts
│   └── main.tsx              # Application entry point
├── guidelines/               # Project guidelines and documentation
├── index.html                # HTML template
├── vite.config.ts            # Vite configuration
└── package.json              # Project dependencies

Tech Stack

Core

Package Version Purpose
React 18.3 UI Library
TypeScript 5.x Type Safety
Vite 6.x Build Tool & Dev Server

UI & Styling

Package Purpose
Radix UI Accessible base components
Material UI Additional UI components
Tailwind CSS Utility-first styling
Lucide React Icon library

Data & Interaction

Package Purpose
Recharts Chart library for analytics
Motion Animation library
React Hook Form Form management
React DnD Drag and drop

Contributing

Contributions are welcome! If you have suggestions or find bugs, feel free to open an issue or submit a pull request.

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature/your-feature-name
  3. Commit your changes: git commit -m 'feat: add your feature'
  4. Push to the branch: git push origin feature/your-feature-name
  5. Open a Pull Request

About

a native usability testing & analytics platform | transforms Miro boards with real-time heatmaps and AI insights

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors