Maintenance ticket plugin for an employee app

This is a student project for Metropolia UAC Mobile Project course. The goal of the course was to work in tandem with a corporate client to produce a mobile and/or desktop based application or tool.

Table of Contents

• Overview
• App features
• Tech stack
• Back-end and API service
• Installation
• Usage & screenshots
• The team

Overview

Through the plugin the user can create a maintenance/safety/feedback ticket and pass it on to be reviewed by the admin.

As an admin you can modify the tickets you received from the users, set their state (open, processing, closed) and send messages to request more info from the person who posted the ticket.

Features:

• Add and view maintenance tickets
• Attach an image and/or an on-site location to a ticket
• Send/receive messages
• Review and change ticket state (open/processing/closed)
• Modify tickets/messages

Tech Stack:

• React (employee & user client)
• NodeJS/Express (API server)
• MySQL (database)
• PhpMyAdmin (database interface)
• Docker (local deployment)

Backend and API doc:

The app stores users and postsin a mySQL database. Post-related images are stored on the server.

Api documentation can be found here and is created with Postman.

Installation

To use test the app as intended, you should download and install Docker Desktop. More info on Docker and its functions can be found at Docker docs.

The DB/Server/Client services run in separate containers from which specific ports are exposed for easy testing with localhost.

Clone this repository (main branch).

After making sure that Docker Desktop is running, navigate to the root of the project (where docker-compose.yml is located), open a terminal and type...

docker-compose up

Usage

User Client (default)

Open http://localhost:3000 to view it in your browser.

Check the init.sql in the db-folder for login credentials. By default, the login-names are...

Admin view:

• Pirjo Mäkinen

Employee view:

• Merili Elnadi
• Matti Stenvall
• Tatu Ihaksi

...which all use the same password (somePW).

New users can be added by modifying init.sql and rebuilding the docker images with

docker-compose down

docker-compose build

Database Admin (default)

Open http://localhost:8080 to view it in your browser.

DB ser credentials are found in docker-compose.yml.

Contributing

Open an issue to discuss contributing to the repo.

The Team (TMNS)

• Merili Elnadi
• Maiju Himberg @maijuhimberg
• Tatu Ihaksi @taaatu
• Matti Stenvall @stenvma81