Skip to content

l2zou/anonymous-chat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Anonymous Chat

Anonymous single-use chatrooms using Flask and SocketIO

Table of Contents

  1. About The Project
  2. Getting Started
  3. Gallery
  4. License
  5. Contact
  6. Acknowledgements

About The Project

This project is a Flask web application that allows annonymous users to create and join chat rooms. After creating a room, a user can distribute the link so that others can join the same room. If a room is empty, it is automatically deleted. To increase security, only rooms codes are stored in the database, not any of the messages, which are rendered using markdown client-side.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You must have Python 3.6 or higher installed.

Installation

  1. Clone the repo and move into it
    git clone https://github.com/BattleMage0231/anonymous-chat.git
    cd anonymous-chat
  2. Install the required packages
    pip3 install -r requirements.txt
  3. Set up the environmental variables and database
    export FLASK_APP=run.py
    export AC_SECRET="SECRET KEY"
    export AC_DATABASE_URI="DATABASE URI"
    python3 init.py # create database
  4. For local use, run the application using the command line
    flask run

For production uses, you should use an existing service to run the application. Do not expose it in debug mode.

Gallery

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Leyang Zou - leyang.zou@student.tdsb.on.ca

Project Link: https://github.com/BattleMage0231/anonymous-chat

Acknowledgements

About

Anonymous single-use chatrooms using Flask and SocketIO

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published