https://github.com/zadigo/messaging_app_template
A simple messaging application using Django and Vue JS
https://github.com/zadigo/messaging_app_template
django forums messaging vuejs
Last synced: 6 months ago
JSON representation
A simple messaging application using Django and Vue JS
- Host: GitHub
- URL: https://github.com/zadigo/messaging_app_template
- Owner: Zadigo
- Created: 2020-03-13T16:29:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T21:35:03.000Z (about 3 years ago)
- Last Synced: 2025-05-07T12:12:53.675Z (9 months ago)
- Topics: django, forums, messaging, vuejs
- Language: JavaScript
- Size: 1.59 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple Django Messaging Template
This is a simple Django messaging template that you can use to quickly prototype a project. Feel free to download and modify for you own needs.
__NOTE:__ This project uses VueJS for the front end. You will need to have knownledge in Vue if you want to keep using it.
In case you need to deploy the application in a Docker environment, the template is shipped with all the required DockerFile and docker-compose files for just that.
## Additional words
The application is built a little bit like Intercom as opposed to a classic Chat application. In other words:
* You can interact with a user via the live chat
* Send email messages via the chat message like it were live messaging
* Create threads with a new user
* View or report a thread
These are the basic functionnalities.
__NOTE:__ On the emailing functionnaly, if the user replies to you and the message is marked as email, then your reply message will automatically be an email.
# Organization
The Pipfile comes with the following applications:
* Redis
* Django
* Celery
* Celery Beat
* Channels
* Channels Redis
* Daphne
* Django extensions
* Zappa
* Django Heroku
* Boto3
* Social Django
## Models
## Views
## URLS
# Starting
Once you've cloned the repository or downloaded the zip file, start your project normally with `./manager.py/runserver` after having run `./manage.py migrate`.
## Redis
You will need to run a redis server locally if you want to benefit from the full live chat functionnalities when developing your application. If you are on Windows, please download the Redis files from the following github account [cuiwenyuan/Redis-Windows-32bit](https://github.com/cuiwenyuan/Redis-Windows-32bit) and then click on the `redis-server.exe` to run it.
## Celery
The template also comes with celery and celery beat in order to create tasks or periodic tasks. For a local development, after running Redis, do `celery worker -A zambda -l info` to start the main process and `celery beat -A zambda -l info` for the scheduler in a terminal of your choice.
# Deployments
## Docker
To run this app with Docker simply run `docker-compose build` or `docker-compose build service_name`. Do `docker-compose up` or `start`.
## Server-less
The application comes directly with Zappa. To deploy in server-less configuration you will need to have an AWS account [in which you must have created an S3 bucket and optionally EC2, VPC, Route 53 an RDS instances]. Run `zappa init` and then `zappa deploy`.
# Machine learning skeleton
The template also comes with a RidgeClassifier ML models. The model classifies a message as sensitive or insensitive depending on its content.
# Support / Development
I will be updating and pushing new features on the different templates on a regular basis. Do not hesitate to watch and star :heart:
If you are interested in me participating in some other projects for you relate to the current work that I have done I am currently available for remote and on-site consulting for small, large and enterprise teams. Please contact me at pendenquejohn@gmail.com with your needs and let's work together!