From 05c6cad8d09b227a4e81d58434bec760a737a986 Mon Sep 17 00:00:00 2001 From: Shay Patel Date: Fri, 29 Dec 2023 18:42:13 +0000 Subject: [PATCH] README --- README.md | 16 +++++++++++++++- requirements.txt | 3 ++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f8f3c5a..28c6d91 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # SupportMe ## A Flask-based support ticket system powered by SQLite +This project was my NEA submission for the AQA exam board, gaining 51 of the available 75 marks. + +## Brief My sister works at a dance studio and often has to deal with many enquiries and issues. Usually, people raise their issues via a telephone call or by email. -The development of a web-based support ticket system would provide a central service which users can use to submit issues, and will also allow for assistants to quickly see unclaimed or unanswered tickets and respond to them promptly. \ No newline at end of file +## Solution +The development of a web-based support ticket system would provide a central service which users can use to submit issues, and will also allow for assistants to quickly see unclaimed or unanswered tickets and respond to them promptly. + +## Running locally +To run the server locally, first install the `pip` dependencies in the `requirements.txt` file. You can do this using ```pip install -r requirements.txt``` + +Then go to the folder and run `python server.py`. + +The web server should be live and running at `localhost:5000`. + +## This repository is NOT maintained +As prevously stated, this was my NEA submission, and I do not intend to maintain this project or repository. If you'd like to send in a pull request, feel free, and if I have some spare time I'll take a look, but don't get your hopes up. \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index bceef2b..b0d5e19 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ PyJWT==2.6.0 -flask==2.2.3 \ No newline at end of file +flask==2.2.3 +Werkzeug==2.2.2