79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
# Pulse
|
|
|
|
[](https://www.gnu.org/licenses/agpl-3.0)
|
|
[](https://nextjs.org/)
|
|
[](https://en.wikipedia.org/wiki/Switzerland)
|
|
|
|
Pulse is the dashboard interface for the Pulse analytics platform. It provides a simple, intuitive interface for managing sites and viewing analytics data.
|
|
|
|
## Features
|
|
|
|
- **Privacy-First Dashboard**: Simple, clean interface for viewing analytics
|
|
- **Site Management**: Create, edit, and delete sites
|
|
- **Real-time Stats**: Live visitor counts and real-time updates
|
|
- **Analytics Views**: Pageviews, visitors, top pages, referrers, countries
|
|
- **Dark Mode**: Full dark mode support
|
|
- **Responsive Design**: Works on desktop and mobile
|
|
|
|
## Technology Stack
|
|
|
|
- **Framework**: Next.js 16+ (App Router)
|
|
- **Styling**: Tailwind CSS with Ciphera design tokens
|
|
- **Charts**: Recharts for data visualization
|
|
- **Authentication**: OAuth flow with ciphera-auth
|
|
- **UI Components**: @ciphera-net/ui for shared components
|
|
- **Hosting**: Swiss infrastructure
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 18+
|
|
- npm or yarn
|
|
|
|
### Installation
|
|
|
|
1. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
2. Set up environment variables (create `.env.local` file):
|
|
```env
|
|
NEXT_PUBLIC_API_URL=http://localhost:8082
|
|
NEXT_PUBLIC_AUTH_URL=http://localhost:3000
|
|
NEXT_PUBLIC_AUTH_API_URL=http://localhost:8081
|
|
NEXT_PUBLIC_APP_URL=http://localhost:3003
|
|
```
|
|
|
|
3. Run the development server:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
4. Open [http://localhost:3003](http://localhost:3003) in your browser.
|
|
|
|
### Build for Production
|
|
|
|
```bash
|
|
npm run build
|
|
npm start
|
|
```
|
|
|
|
## Design System
|
|
|
|
The frontend follows the Ciphera design language:
|
|
|
|
- **Brand Color**: Orange (#FD5E0F) - used as accent only
|
|
- **Neutral Colors**: Full scale (50-900) for UI elements
|
|
- **Dark Mode**: Full support with class-based switching
|
|
- **Font**: Plus Jakarta Sans
|
|
- **Design Patterns**:
|
|
- Rounded corners (rounded-xl, rounded-3xl)
|
|
- Smooth transitions (duration-200, duration-300)
|
|
- Shadow effects with brand-orange accents
|
|
|
|
## License
|
|
|
|
AGPL-3.0
|