ToDoChat

Setup

Setup virtual environment

virtualenv -p python3 venv/
source venv/bin/activate

Install packages

pip3 install -r requirements.txt

Setup database

Fill my.cnf with MySQL informations

sudo nano /etc/mysql/my.cnf

[client]
database = db_name
user = user
password = mysql_password
default-character-set = utf8

Create config

Create /etc/config.json file:

{
  "SECRET_KEY": "",
  "EMAIL_USER": "",
  "EMAIL_PASS": "",
  "ALLOWED_HOSTS": "*",
  "DEBUG" : true,
  "WS_PORT": 6379
}

EMAIL_USER, EMAIL_PASS are used for password reset with gmail smtp.

Frontend

npm install sass

sass --watch todochat/app/static/scss:css

Collect static for django-ckeditor

python3 manage.py collectstatic

Migrate and start server

python3 manage.py migrate

docker run -p 6379:6379 -d redis:5

python3 manage.py runserver

Troubleshooting

Error: EACCES: permission denied, access '/usr/local/lib' (npm install sass error)**

sudo npm install sass

Problems installing mysqclient

sudo apt-get install python3-dev default-libmysqlclient-dev build-essential

Technologies used

• Django
• WebSockets (django-channels + redis)
• MySQL
• Redis
• HTML / Css / JS
• Bootstrap
• Daphne (for WebSockets) on deployment
• Apache2

ToDo

• HTML and CSS needs to be rewritten or at least refactored (app is not accessible yet and css has a lot of unused styles)
• RWD for larger devices (now working on mobile devices only for testing backend functionality)
• Finish DOCS