Skip to content

Vaultarq/Dashboard

Repository files navigation

Vaultarq Dashboard

A modern, secure web dashboard for Vaultarq, the CLI-based secrets vault tool.

🚀 Features

  • Secure Secret Management: Safely store and manage your API keys, passwords, and sensitive data
  • Environment Support: Organize secrets across multiple environments (dev, staging, prod)
  • CLI Integration: Seamless sync between the dashboard and your local Vaultarq CLI
  • Audit Logging: Track all actions performed on your vaults
  • Import/Export: Easily import and export secrets in .env format
  • Mobile Responsive: Fully responsive design works on all devices
  • Client-Side Encryption: Optional client-side encryption for maximum security

🧱 Tech Stack

  • Frontend: Next.js (App Router) + Tailwind CSS + shadcn/ui
  • Auth & DB: Supabase (PostgreSQL, RLS, Auth, Storage)
  • Deployment: Vercel (optimized for edge functions)
  • State Management: Zustand

📋 Pages

  • Landing Page: Introduction to Vaultarq and its features
  • Auth: Supabase magic link login + GitHub OAuth
  • Dashboard: Summary of environments and recent activity
  • Vault Management: Add/edit/delete secrets for each environment
  • Audit Log: Detailed history of all actions
  • Settings: User profile, security settings, device management

🔧 Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Supabase account

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/vaultarq-dashboard.git
    cd vaultarq-dashboard
    
  2. Install dependencies

    npm install
    
  3. Setup environment variables

    cp .env.example .env.local
    

    Then update your .env.local file with your Supabase credentials:

    NEXT_PUBLIC_SUPABASE_URL=https://your-project-ref.supabase.co
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
    
  4. Run the development server

    npm run dev
    
  5. Open http://localhost:3000 in your browser

🔐 Setting Up Supabase

  1. Create a new Supabase project
  2. Use the SQL schema in docs/schema.sql to set up your tables
  3. Configure the authentication providers in the Supabase dashboard:
    • Enable Email (with magic link option)
    • Enable GitHub OAuth (optional)
  4. Add your Supabase URL and anon key to your .env.local file:
    NEXT_PUBLIC_SUPABASE_URL=https://your-project-ref.supabase.co
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
    
  5. Set up Row Level Security (RLS) policies as described in the schema file

📦 Deployment

Deploy your own Vaultarq Dashboard with Vercel:

Deploy with Vercel

🔗 CLI Integration

To connect your Vaultarq CLI to the dashboard:

vaultarq login --token YOUR_TOKEN

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published