Peppermint

Welcome to Peppermint Ticket Management 🍵

This project is supported by:

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

Introduction

It's a self hosted alternative to popular services such as zendesk

✨ Features

• Ticket Creation: Bog standard ticket creation with a markdown editor and file uploads
• A log of client history
• Markdown based Notebook with todo lists
• Responsive: Designed for variable screen sizes from mobile up to 4k
• Multi-deployment: Quickly deploy using docker & pm2
• Simple to Use: Designed to be easy to use with a simple logical workflow

🐳 Installation with docker

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

version: "3.1"


services:
  peppermint_postgres:
    container_name: peppermint_postgres
    image: postgres:latest
    restart: always
    ports:
      - 5432:5432
    volumes:
      - pgdata:/var/lib/postgresql/data
    environment:
      POSTGRES_USER: peppermint
      POSTGRES_PASSWORD: 1234
      POSTGRES_DB: peppermint

peppermint:
    container_name: peppermint
    image: pepperlabs/peppermint:latest
    ports:
      - 3000:3000
      - 5003:5003
    restart: always
    depends_on:
      - peppermint_postgres
    healthcheck:
      test: ["CMD", "sh", "-c", "wget --spider $$API_URL"]
      interval: 30s
      timeout: 10s
      retries: 3
    environment:
      DB_USERNAME: "peppermint"
      DB_PASSWORD: "1234"
      DB_HOST: "peppermint_postgres"
      SECRET: 'peppermint4life'
      API_URL: "http://server-ip:5003"

volumes:
 pgdata:

Once this is completed then you can go to your server-ip:3000 which was added to the compose file and login.

The default login credentials are

admin@admin.com
1234

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

Documentation

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

Motivation

• This was initially a project to tie together my react and nodeJS skills and show something for my portfolio
• It looked terrible! But it worked and showed functionaility, which got me a job.
• Learn and deploy with docker
• Redo the UI, completly from the ground up. Which has now been completed and for me looks great.
• Build on this foundation and create a fully fledged product which offers what the big boys offer, but, at a much better ROI than signing up for zendesk etc.

Give a ⭐️ if this project helped you!

Screenshots

Star History

Activity

Author

👤 Jack Andrews

• Website: peppermint.sh
• Twitter: @andrewsjack18
• Github: @potts99
• LinkedIn: @jack-andrews-146852131