Skip to content

Repository files navigation

DeskMint Frontend

DeskMint is a source available web application designed to simplify workflows for small businesses, teams, and organizations. It aims to streamline client communication, document management, invoicing, and task management through a centralized platform.

Project Overview

This repository contains the frontend for DeskMint. The frontend is built using modern web technologies, and it's intended to work seamlessly with the DeskMint backend (which you can find in the deskmint-backend repository).

Tech Stack

  • Vue.js (for building interactive UI components)
  • Tailwind CSS (for utility-first CSS styling)
  • Axios (for making API calls to the backend)
  • Vue Router (for routing between pages)
  • Pinia (for state management)
  • Dark Mode (a toggleable dark/light theme)
  • Custom UI Components (Buttons, Tables, Checkboxes, etc.)

Features

  • Minimalistic Design similar to leading dashboard platforms (like Stripe)
  • Left Sidebar Navigation for easy access to the app's modules
  • Responsive Layout that works well on both desktop and mobile
  • Dark Mode toggle for a personalized user experience
  • Panel with management tools for clients, tasks, invoices, and documents

Installation (With docker)

Clone this repository:

git clone https://github.com/parthmp/deskmint-frontend.git
cd deskmint-frontend

run below commands

docker compose up --build -d
chmod +x docker.dev/setup.sh
docker.dev/setup.sh

setup.sh only should be ran on the initial setup, no need to run it again with docker down and up commands after it

Open src/env.ts file and set TURNSTILE_KEY to your cloudflare turnstile key.

Fixing Vue + TypeScript Autocomplete in WSL

If Vue autocomplete (reactive, ref, props, etc.) is broken inside VS Code, follow these steps.

1. Fix permissions for the frontend folder

If node_modules was created by Docker or root, TypeScript can't load properly.

Run this once:

sudo chown -R $USER:$USER ~/deskmint/deskmint-frontend

Install TypeScript inside the project

VS Code needs the workspace version of TypeScript.

cd deskmint-frontend
npm install --save-dev typescript

Make sure VS Code is in WSL mode, bottom-left should show WSL: Ubuntu-24.04 (or your distroname)

Installation (Without docker)

Prerequisites

  1. Node.js (v16.x or higher)
  2. npm

Clone this repository:

git clone https://github.com/parthmp/deskmint-frontend.git
cd deskmint-frontend
npm install
npm run dev

🔒 License: DeskMint is source-available software licensed under the Elastic License 2.0. You are free to view, modify, and self-host it for personal and commercial usage. However, you are not allowed to offer it as a hosted service or sell it as a SaaS product without a commercial license.

About

Frontend for: DeskMint - Side project- Modular productivity suite: tasks, chat, invoicing and vault.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages