Giter VIP home page Giter VIP logo

aabkoala's Introduction

Automated Audit Benchmarking System - By Team Koala

Bacause of the increament of the audit data, a regular Excel file is not capable of handling the increasingly complex data structure and audit process conducted by the ARPANSA. As a result, a database is urgently required. This project normalised the Excel data into a Mysql database schema and implemented a backend that automates the "IMRT" and "3DRT" analysis process.

In addition, an local program is developed as a substitution of front-end to allow user to run the automated process with various options.

Recommended System Requirement

  • CPU: 3.2GHz x 2 cores
  • RAM: 16GB
  • Hard drive: 40GB
  • Operating system: Linux(centOS)

Technology

  • Database: Mysql 8.0
  • Backend: Django Rest Framework 3.11.1
  • Deployment: Docker 19.03.13
  • Python dependencies:
    • Django 3.1.1
    • mysqlclient 1.4.0
    • matplotlib 3.3.1
    • pandas 1.1.1
    • drf-yasg 1.17.1

Getting Started

Deploy our service

Before you start, make sure git, docker and docker-compose are installed on the server.(If you need help with this, instructions can be found in our deployment guide)

1. Pull code from our github repo

git clone https://github.com/geoffreychen831/AABKoala.git

(Alternatively, you can upload the code in server directory onto the server)

2. Deploy

cd Server
sudo docker-compose up -d

Use local program

Once deployment completes, you can use local program to run our predefined audit process. Here takes inserting result as an example.

  1. Open uploadData.xlsx and fill in the data you want to insert into database

  2. Open the Demo.py and call insertResult()

from LocalProgram.resultRequest import *
resultRequest.insertNewResult()
  1. If it returns a json in the console, meaning it has succesfully inserted the result
  2. You can check the inserted result by calling listResults()
from LocalProgram.resultRequest import *
resultRequest.listResults()
  1. Go to download folder, open the downloaded Excel, all the data in database are now downloaded in this file.

For full instruction, please refer to our Local Program Document

Documents

Test

Changelog

List of files

├── Doc
├── LocalProgram
│   ├── Demo.py
│   ├── config.py
│   ├── graphRequest.py
│   ├── resultRequest.py
│   ├── tests
│   └── upload
└── Server
    ├── AAB
    │   ├── asgi.py
    │   ├── settings.py
    │   ├── urls.py
    │   └── wsgi.py
    ├── apps
    │   └── graphs
    │       ├── Services
    │       │   └── graphService.py
    │       ├── admin.py
    │       ├── apps.py
    │       ├── migrations
    │       ├── models.py
    │       ├── serializers.py
    │       ├── tests
    │       │   ├── test_urls.py
    │       │   └── test_views.py
    │       ├── urls.py
    │       └── views.py
    ├── utils
        ├── images
        ├── plGraphs  
        ├── plot.py
        └── sample.py

Motivational Model

  • Functional Goal Functional Goal
  • Non-functional Goal Non-functional_Model

Personas

personas

aabkoala's People

Contributors

juncheng-li avatar yunninggong avatar geoffreychen831 avatar meichenlin avatar maxrere avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.