README

Crisis Management System

SETTING

This is a project created during the Spring 2020 semester at Southern State University for the Senior Software engineering class. It is sponsored by Dr. A And Dr. B (MIS professors) and directed by Dr. C (Computer Science professor) at Southern State University (pseudonym). Through the use of web technologies, the portal has been implemented with Django and the database portion using MySQLite.

REQUIREMENTS

System: Windows 10(for demo) or server with Apache (for production)

Python 3.8.2+

Python Dependencies:

appdirs 1.4.3

asgiref 3.2.7

bleach 3.1.5

click 7.1.2

distlib 0.3.0

Django 3.0.5

filelock 3.0.12

joblib 0.14.1

markdown2 2.3.8

nltk 3.5

nltk libraries: stopwords and punkt

numpy 1.18.3

packaging 20.3

pbr 5.4.5

pyparsing 2.4.7

pytz 2020.1

regex 2020.4.4

scikit-learn 0.22.2. post1

scipy 1.4.1

six 1.14.0

sqlparse 0.3.1

stevedore 1.32.0

tqdm 4.45.0

virtualenv-clone 0.5.4

webencodings 0.5.1h

INSTALLATION

Windows installation guide:

Download and install version python 3.8.2+

Ensure that Windows Command Prompt has access to Python commands:

1. Go to Control Panel

2. Go to System

3. On the left side of the System window select Advanced system settings.

4. At the bottom of the System Properties window, select Environment Variables

5. Under “System Variables” select and double click “Path", A new window will appear

6. Click New then Browser on the right side of the new window

7. In the “Browse For Folder”, Navigate to you Python installation and select “Python38-xx” file

Example Python Install location (Try this path, but may differ depending on system):

This PC -> Windows (C:) -> Users -> [Name of User] -> AppData -> Local -> Programs -> Python -> Python 3.8-32

8. Click OK in the Edit environment variable window

9. Click OK in the Environment Variables window

10. Click OK in the System Properties window

11. Test the configuration by opening a Command Prompt window and typing “python -V” and you should see Python 3.8.x

Command Prompt Tips:

Command Action

cd <name of file> -change into folder in current directory

cd .. -return to the previous directory

dir -list all files in the current directory

Resource for command prompt commands: https://www.digitalcitizen.life/command-prompt-how-use-basic-commands

Install program and python dependencies:

1. Extract Crisis-Knowledge-Base file to the desired location.

2. Start a command prompt and navigate, utilizing cd command, to the /Crisis-Knowledge-Base program location

in command prompt For example.

3. To install dependencies type “python -m pip install -r requirements.txt”

4. Wait for the installation to complete

Install nltk required libraries:

1. Open Command prompt

2. Type “python -m nltk.downloader stopwords”

3. Type “python -m nltk.downloader punkt”

4. Allow both files to finish download.

STARTING PROGRAM

1. Open Command Prompt

2. Navigate to the /Crisis-Knowledge-Base/Crisis_KBMS project location utilizing command prompt

3. Start the application by typing python manage.py runserver

4. Your server will start on a local host address ie. http://127.0.0.1:8000/

5. Go to that address to access the web application

Creating Admin/Super User

1. Open Command Prompt

2. Navigate to the /Crisis-Knowledge-Base/Crisis_KBMS project location utilizing command prompt

3. type “python manage.py createsuperuser”

4. When prompted enter username and press enter

5. when prompted enter a generic email address and press enter

5. When prompted enter password and press enter

6. When prompted reenter password

7. You should now have a super user that can be utilized to log into the admin page

Admin Portal:

1. First create a super user with instructions above and then start program

2. To access the admin portal you will need to go to the local host /admin. http://127.0.0.1:8000/admin

3. log in utilizing your admin credentials

4. Features of admin page

a. Add users and groups.

b. View or add information regarding the Crisis Management Knowledge base side of the app

c. View or add Add information

5. To explore more option you can click on a subject such as Knowledge which will allow you to view a list of

knowledge content.

Crisis Web Application:

1. To access the Web Application first Start the Program

2. Go to local host http://127.0.0.1:8000/

3. Enter admin or user credentials.

4. you can now navigate the application by utilizing the navigation bar at the top of the page.

5. you can view profile information by clicking the picture of a person in the top right of the page.

6. Post will allow you to post a question

7. View will allow you to view posted questions

8. Knowledge-base will allow you to view admin entered Knowledge and posted a question related to the entered query.

The results will be displayed in order by relevancy.

ABOUT DATABASE CONTENTS

The sample data in place currently has a core based around the crisis management best practices for Southern State University

found here: (hidden here for blind peer review)

Each item serves as a preloaded entry and directly relates to real-world data.

***Note through access to the administrative side of the project a user will have the authority to add Knowledge-Base

Entries of their own. (see sec. Admin Portal to access)

RESOURCES

Django - https://docs.djangoproject.com/en/3.0/

markdown2 - http://www.web2py.com/examples/static/sphinx/gluon/gluon.contrib.markdown.html#module-gluon.contrib.markdown.markdown2

nltk - https://www.nltk.org/

numpy - https://numpy.org/

scikit-learn - https://scikit-learn.org/stable/user_guide.html

scipy - https://www.scipy.org/docs.html