theguardianwolf / flame-chat

UoA Chat App Project

README

This README would normally document whatever steps are necessary to get your application up and running.

Report and presentation:

• Report.pdf
• Presentation.pptx

Dependencies

Located in the packages folder. Extract the folders from the zip, except 'Crypto' because that doesn't seem to work unless you install it.

Run

cd /path/to/project
export PYTHONPATH=./:./packages
python2 ./app/Server.py

If you're on Windows, just run the .bat file. (Sorry, I can't write Bash).

Visit localhost:10001 afterwards and the web page should be up. This may take a while to load depending on your connection to CDNJS.

Test

Server must be up for this to work.

cd /path/to/project
export PYTHONPATH=./:./packages

# IF YOU HAVE PYTEST
pytest test

# IF NOT
python2 ./packages/pytest/pytest.py test

If you're on Windows, run the .bat file with ---run-tests.

Blacklisting

Blacklist is located in app/Config/blacklist.json, update according to the following model:

[ 
    { 
        "entry": "asut324", 
        "type": "username" 
    }, 
    { 
        "entry": "9.9.9.9", 
        "type": "ip" 
    } 
]

Rate Limiting

Public apis are IP restricted to 20 requests per 5 seconds.

Support List

Everything C Grade - asut324, wcha609

Embedded media - asut324, smoh944, abha808

User status - wcha609, asut324

Blacklisting - Put someone in my blacklist

Rate Limiting - Just ping me 20 times in 5 seconds

Inter-App Encryption and Hashing - hone076 (or hone075??? Which one is Hamish), ssit662

P2P Networking - User cache only, block login server and it will default to cache

Offline Messaging - smoh944, abha808, ssit662, asut324

Fails Graciously - dwye244, hdin898 + potentially others, been hard to find 'substandard'

Contacts

Jerry Fan - [email protected]