Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 2.97 KB

README.md

File metadata and controls

95 lines (70 loc) · 2.97 KB
Raw

###CryptoIM

CryptoIM is a chat client that leverages the crypto Javascript library, new with ES6, to create RSA keys, and encrypt and decrypt messages in the browser.

  • Allows users to chat, without sharing their raw messages with the server.
  • Allows users to know who is joining them to chat.

Version

0.1.0

Tech

CryptoIM is built on the following technologies and libraries:

  • PostgreSQL - SQL open-source relational database.
  • Python - Object-oriented programming language.
  • Flask - Web framwork for Python.
  • Flask-SQLAlchemy - Flask plugin to facilitate communication between the server and the PostgreSQL database.
  • Javascript - Of course!
  • jQuery - To make Javascript better!
  • Crypto - Javascript crypto library new in ES6.
  • Twitter Bootstrap - Great UI hooks for CSS to make a beautiful site quickly.

Installation

First you'll need:

  • pip - In order to find install all the python dependencies.
  • PostgreSQL - The database software necessary to save conversation and user data.
  • virtualenv (recommended) - To keep all the dependancies in order

To get the server running:

  1. Create a virtual environment.

  2. Activate your virtual environment:

    $ <path_to_env>/bin/activate

  3. Clone github repo:

    $ git clone https://github.com/KTAtkinson/crypto-im

  4. Add PostgreSQL to your path.

  5. Create the chat-client database:

    $ createdb chat-client

  6. Create database tables:

    $ <path_to_project>/model.py
>>>

  7. In the interpreter use db.create_all() to create all the tables.

  8. Install python depencencies in your virtual env:

    $ pip install -r <path_to_project>/requirements.txt

  9. Run the server:

    $ python <path_to_project>/server.py

  10. Navigate to localhost:5000 in your web browser. ![Image of front page] (https://github.com/KTAtkinson/crypto-im/blob/master/docs/img/Screen%20Shot%202016-03-08%20at%205.53.16%20PM.png)

  11. To stop the server type Ctrl+c in your terminal.

In order to have a conversation between two different users they must be in different browser sessions. The easiest way to do this is to have one window open in your session and another open in an incognito/in-private window.

Todos

  • Add a help page.
  • Implement add chat button in upper right of chat page.
  • Allow encryption of long messages.
  • Store messages as base64 encoded text on server.