/Peppermint

A ticket management system which aims to have a nice UI with easy to use features, lightweight infrastructure & the ability to run on any hardware you want 🍵

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Welcome to Peppermint Ticket Management 🍵

Logo

Version Github Stars:

This project is supported by:

Buy Me A Coffee

Ticket Management System in order to help helpdesks & service desks manage internal staff & customer requests

Installation

Currently only linux has been verified as working but we are open to the idea of supporting windows eventually as well.

Keep in mind, this is an alpha so the risk of data loss is real and it may not be stable, we do not recommend anyone runs this in a production enviroment.

Check out the getting started guide if this is the first time you've used Peppermint:

version: "3.1"

services:
  postgres:
    container_name: postgres
    image: postgres:latest
    restart: always
    volumes:
      - ./docker-data/db:/data/db
    environment: 
      POSTGRES_USER: peppermint
      POSTGRES_PASSWORD: 1234
      POSTGRES_DB: peppermint

  client:
    container_name: peppermint
    image: pepperlabs/peppermint:latest
    ports:
      - 5000:5000
    restart: on-failure
    depends_on:
      - postgres
    environment:
      JWT_SECRET: 'ZwfJtS3muY65CaeZ' 
      PORT: 5000
      DB_USERNAME: peppermint
      DB_PASSWORD: 1234
      DB_HOST: 'postgres'

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

Setting up postgres on Macos in a container for local development

docker run --rm -P -p 127.0.0.1:5432:5432 -e POSTGRES_PASSWORD="1234" --name pg postgres:alpine

One click installers

  • We are now on linode marketplace we can be viewed here here

Supported Environment Variables

You can utilize the following environment variables in Peppermint. None of them are manditory.

Variable Description
PUID Set userid that the container will run as.
PGID Set groupid that the container will run as.
JWT_SECRET Keep your passwords and user logins secure with a JWT SECRET
DB_USERNAME Enter database username here
DB_PASSWORD Enter database password here
PORT Choose a custom port to run the app on rather than the default 5000

💻 Demo

If you're interested in trying out Peppermint we currently have a demo working here.

The credentials are

email: admin@admin.com
password: 1234

✨ Features

  • 💡 Job Logging
  • 📜 Client History
  • 💎 Notes creation & Todo List
  • 📐 Admin Page: Admin Dashboard for easy webUI changes and analytics
  • 📱 Responsive: Designed for variable screen sizes from mobile up to 4k
  • ⚙️ Docker-Ready: Quickly deploy using docker
  • ✅ Usage: No barriers to use with complete documentation on how to complete tasks

Roadmap for new features

There is currently a trello roadmap available which is updated daily - https://trello.com/b/tOMsptar/peppermint

Documentation

We have started working on creating documentation for peppermint which covers development to general usage. Click here to be taken directly there.

Installing locally for development

If you're interested in developing for Peppermint, wether that be a bug fix or locally we have a guide on our wiki

Notes for ARM devices

We currently have an image for arm devices but are seeing issues with mongoDB so we do not offically support 32 bit or 64 bit as of this time.

Author

👤 Jack Andrews