title	date
RAT Document Databrowser User Guide	2022-06-04

RAT Document Data Browser User Guide

Introduction

RAT Document Data Browser empowers users to move their data to the Internet without the limit of devices that are used. It allows people to check data with any device at anytime as long as it is connected. It opens brand new avenues for managing rat document data in ABM (Agent Based Model) field.

RAT Document Data Browser, which we name RatDB for simplicity, is intended to be flexible and provide not only all the basic functionality to allow people to easily manage data online, but also some relevant document recommendations for them based on the previous data they uploaded.

RatDD enable you to create and share your data on the platform. When you upload data, you can choose if it can be public. On the platform, you can also have a look at other's public rat documents.

Notes: As the website hasn't been deployed in the Internet, so the project can only run locally now and the following instructions are only for the purpose of testing and they require some CS knowledge background. However, if you don't want to be bothered, you can just watch the video of this website in action as well.

Preparations

In order to run the project locally, please make sure your PC has npm, React library, and python Django installed, and follow the steps below.

To initialize the RatDB project:

Upzip the project file.
Open front-end file in the terminal (If your OS is Windows, it will be Command Prompt). Type 'npm start' and run to activate the front-end.
Open back-end file in the terminal. Type 'python manage.py runserver' and run to activate the back-end.
You will see a view of the website of which the url is http://localhost:3000/:
Connect to the database. Open settings.py file in the subdirectory rat_rs under the directory back_end and change the database info to yours.

If you don't have any database software like MySQL, you can just use the embedded database of Django and reset the setting like that:
```
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}
```
Visit http://127.0.0.1:8000/admin/ url via your browser, and log in the Django administration with the username arieskoo and the password gw010101. After that, add at least one user information manually. And then you are able to test the website finally.

Please move to Developer Guide to see more details of this project.

Log In

To access your data, or data to which you have permission to access, you must log in:

Open the browser, and visit http://localhost:3000/ url
Input username and password, and click 'Sign in' button.
After successfully logging in, you will see all of the data which you have read permission to.

Log Out

To log out the account:

Have a look at the top right corner of the website where a 'log out' button is.
Click 'Log Out' button.

Functionality

Navigation

Click 'Personal Center', you are able to view and change your info.
Click 'Data Center', you can see how many documents you've already uploaded so far.
Click 'Upload', you will see all the questions. So you can fill the form and submit your new RAT document.

Personal Center

Here you can change all your information when you registered for the first time.
After changing all the information, you should click the 'submit' button in order to sync the data in our database.

Data Center

In Data Center, you can manage all the data you uploaded before. The operation includes adding, deleting, updating, etc.

If you click the red 'delete' button, all the information about that paper will be deleted forever.
if you click the blue 'edit' button, it will lead you to a new page in order to edit all information of that specific paper.
After the operations, don't forget to click the 'submit' button.

Recommendations

In Data Center, we can see 'Feed' button, if you already uploaded some documents, the platform can calculate and recommend you some paper here.

Click 'Feed' button
Wait for a while (it depends on how many documents you uploaded), you will see some recommendations.

Upload your RAT document

In Upload section, you can upload your RAT document by filling the form.

Read all the questions, and answer them if neccessary. Remember you don't have to anwer all the questions.
After that, type your ABM paper name.
Finally, choose if you want to make it public. If you haven't finished, you can just publish it later. And then click 'submit' to save your file.

DashBoard

So far, DashBoard can provide all the public RAT documents for every user.

Click 'DashBoard' button in the top left of the browser.
You will see a bunch of RAT document that has been public by others and yourself.
If you click any of them, you can enter the document and see the content that the user already filled.
However, remember all of them are read only. So you can only have the permission to read. And also if other users change the public status of the document, you will not be able to access that again.

Wizard-Guido/Dissertation-Project-AI-Driven-Report-Management-Website