This is the project that I served as an Intern at eCloudValley in 2024/03-2024/05. The project is to build a ticket system for the customer service department.

Developing Requirements

Python version python3.11 or later with poetry to manage the dependencies.

[!IMPORTANT] If you have not installed poetry, please install it by following the official guide

Required Dependencies

gradio = "^4.31.0"
uvicorn = "^0.29.0"
aws-cdk-lib = "^2.141.0"
constructs = "^10.3.0"
mangum = "^0.17.0"

Build `venv` for MacOS

$ python3.11 -m venv venv
$ source venv/bin/activate
$ poetry install
$ rm -rf venv     # remove the venv

Build `venv` for Windows

$ pip install virtualenv
$ virtualenv venv
$ venv\Scripts\activate
$ poetry install
$ rmdir /s venv     # remove the venv

Run web app

Edit the .env file with your own token. Also need to follow the mode of the web app.

$ cp .env.example .env.<MODE>

# Ticket System Part
DEPARTMENT_ID="MSP_ID"
 
# API Endpoint Part
SUBMIT_TICKET_API_URL="DEPLOYED_SUBMIT_TICKET_API_URL"
LIST_LOG_SEGMENT_API_URL="DEPLOYED_LIST_LOG_SEGMENT_API_URL"
LIST_CHAT_HISTORY_API_URL="DEPLOYED_LIST_CHAT_HISTORY_API_URL"
BEDROCK_API_URL="DEPLOYED_BEDROCK_API_URL"
 
# AWS CDK Part
CDK_DEFAULT_ACCOUNT="YOUR_AWS_CDK_DEFAULT_ACCOUNT"
CDK_DEFAULT_REGION="YOUR_AWS_CDK_DEFAULT_REGION"

Run the web app with the following command.

# run the web app in development mode
$ python app.py --port 8080 --dev
# run the web app in test mode
$ python app.py --port 8080 --test
# run the web app in production mode
$ python app.py --port 8080 --prod
 
# Also you can customize the port number
$ python app.py --port 8081 --dev

[!NOTE] If you want to run the app with the uvicorn server, so that you can design your own API and reload the app, you can run the following command.

$ ./scripts/run.sh
 
# or
$ uvicorn app.main:app --host 0.0.0.0 --port 8080 --reload

This will use the .env as the default configuration file.

Deployment

with docker installed, you can build and run the docker image.

Build the docker image

$ docker build -t todam-ticket-system:<TAG_NAME> .
 
$ docker run -p 8080:8080 todam-ticket-system:<TAG_NAME>

Deploy to AWS Lambda Function with AWS CDK

$ cdk bootstrap
$ cdk deploy

Authors

Chun-Ho (Hugo) Lin Website | GitHub | E-mail
@kkueen111
@Mon-maker
@rasperberrypie
@sh1un
@ShiuanTHC
@supereason0517
@TODAM-tw

License

Released under Apache License by TODAM-tw.

← Back to Project