Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.96 KB

README.md

File metadata and controls

55 lines (38 loc) · 1.96 KB
Raw

Banter Realtime Chat App

Live Deployment: Still in development

Banter - a realtime chat application built in Django, Vue, MySQL, Redis, and Docker.

Features and Technologies

  • WebSockets utilizing Redis, Django Channels, and the WebSocket API
  • Used Django ORM and MySQL to setup the database
  • Setup the development environment utilizing a complex Docker setup
  • Production pipeline handled through Docker
  • Frontend using TailwindCSS and Vue Composition API

Setting up the Development Environment

Clone the repo and cd into the directory

git clone https://github.com/kanielrkirby/banter
cd banter

Copy the example.env

cp example.env .env

Run the Docker Compose file

docker compose -f docker-compose.base.yml -f docker-compose.dev.yml up

Try setting up an alias if you're using this often (for whatever reason haha)

alias banter="docker compose -f docker-compose.base.yml -f docker-compose.dev.yml up"

Now you can view the project on localhost:4173

Contributing

This is a personal project meant to learn, and isn't meant to be expanded! But if you find this useful for whatever reason, feel free to fork it to your own repo!