dionyziz / ting Goto Github PK

View Code? Open in Web Editor NEW

19.0 14.0 31.0 1.04 MB

A chat system

License: MIT License

ApacheConf 0.04% CSS 14.16% HTML 13.52% JavaScript 35.43% Python 33.12% Nginx 0.25% Shell 0.55% Makefile 2.92%

ting's Introduction

Ting is a chat platform.

To learn what the vision for ting is, see /etc/spec/SPECIFICATION.md.
For the technical architecture, see /etc/spec/ARCHITECTURE.md.
We have a bug database. Ask for access to our trello board. Pick a bug and fix it.
We use ting.gr/dev and a Facebook chat for development team discussions. Ask for access.

Running Ting

git clone
Set up a MySQL database
Make a copy of config/common.json into config/local.json and add your settings.
Install NodeJS and the dependencies required to run Django installation by running sudo apt-get install python-dev libmysqlclient-dev libffi-dev python-pip nodejs nodejs-legacy. Install yarn.
Make a virtual python environment using virtualenv venv on the API/ folder. We recommend this because the API will use its own copies of python and of the required dependencies, so you can update your libraries in your system without worrying that you might "break" the API. In order to use the virtual environment you only have to run source venv/bin/activate when you want to run python or pip. To deactivate it you can just run deactivate or close the terminal.
Run pip install MySQL-python.
Go to API/ and run pip install -r requirements.txt to install all the dependencies of Django server.
Run the Django server using python manage.py runserver inside the API folder. If it asks you to run migrations, do it.
Install the required dependencies for the node server and the client by running yarn install in client/ and realtime/.
Run the node service using node server.js or forever start server.js inside the realtime folder.
Build the client-side bundle with yarn build inside the client folder. Or run yarn build --watch if you plan to edit the client-side source.
Set up nginx to statically serve the client folder.

Contributing

Work on your own fork.
Never push to the main repo. Always create a feature branch and pull request.
You need an LGTM to merge. All review comments must be resolved even if you have an LGTM.
A pull request can be merged by the author or by the reviewer giving the LGTM.
Make sure your commits are clean and atomic. Commit messages must be descriptive. Rebase if you have to.

Authors

Alphabetically.

Aleksis Brezas
Antonis Skarlatos
Carolina Alexiou
Dimitris Lamprinos
Dionysis Zindros
Eleni Lixourioti
Kostis Karantias
Petros Angelatos
Vitalis Salis

ting's People

Contributors

Stargazers

Watchers

ting's Issues

Migrate from gulp/browserify to babel/webpack

Too many users (20+) sending messages (300+) over the course of some minutes makes message delivery slow

Increased vertical spacing between messages

Separate unread messages with line

Update README instructions with create db step

Spam: Repeated message - message throttling

Reverse proxy node through nginx so that everything runs on port 80

Migrate all JS to coffee

There are still some things on the front-end that use JS instead of coffee (e.g. controllers). Migrate them to coffee.

Notification when username is mentioned

Messages that start with spaces don't get sent

Basic chat history

Store chat history using PostgreSQL. When a user logs in, display the latest messages as part of the history.

LastPass thinks text-input is a username form

Race condition when emoticons are used before they're loaded

Update README installation instructions

Move emoticons.define() call to the component load event of messageClass

Can't read typing mssages because of their opacity

When there's a new user, let them choose an avatar for their profile. The avatars should be a list of cartoon animals stylized in a similar way (e.g. all in circles). An avatar should be selected by default randomly when the user starts.

Dockerization doesnt support unicode text (so api fails for greek usernames or messages)

Nickname generation on login

Make the login screen automatically generate a new nickname if you don't already have one. The nicknames should be greek. They should be a combination of two words, capitalized, one adjective followed by one noun, and they should match in gender e.g. "ΜπλεΙπποπόταμος" or "ΧαζήΤυροκροκέτα". This should be pre-filled so that the user doesn't have to actually type any nickname before joining.