HELPDESK

IMPORTANT: This project is currently under development

Introduction

This a ticketing software for support teams. It can be used to provide support for either internal(employees) or external users(customers).

Requirements

This is a NodeJS application and should be able to run on Linux, Windows and Mac. It only requires the following dependencies to be installed first:

• Nodejs version 6.10+
• Mongodb version 3.4+
• Yarn

How to install

Use git or Download Zip option to download the software.

git clone git@github.com:brandiqa/helpdesk.git
cd helpdesk

# Install frontend dependencies
yarn install

# Install backend dependencies
cd backend
yarn install

How to configure

You'll need to configure the following:

Mail and Database Services

Todo: write instructions for mail and db config.

Application

At the root of the application, create a file and name it .env. Paste the following code inside:

# babel
REACT_APP_BABEL_STAGE_0=true
REACT_APP_DECORATORS=true

How to run

Start the backend server first!

cd helpdesk/backend
yarn start

Start the frontend server

cd helpdesk
yarn start

Once the startup process is completed, your browser should automatically launch with the url http://localhost:3000.

You can log in with the default admin account:

email : admin@example.com password : admin

Documentation

todo: record a screencast todo: write a tutorial