hashkitti001 / webChatO

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

WebChatIO

Welcome to the Flask SocketIO Chat App! This project is designed to provide a real-time chatting experience with anyone. With the power of Flask and SocketIO, you can engage in seamless conversations with friends, family, or even strangers.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Contact
  6. Acknowledgments

About The Project

Capture.png

(back to top)

Built With

  • Flask
  • socketIO
  • Jinja
  • MYSQL
  • JS
  • PYTHON
  • HTML
  • CSS
  • render

(back to top)

Getting Started

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

Prerequisites

There are no requirements.txt file, so you hard-install...

  • dependencies
    pip install flask flask-socketio flask-migrate flask-mysqldb flask-loginpython-dotenv

Installation

  1. Get a free MYSQL database at https://www.freesqldatabase.com/

  2. Clone the repo :

    git clone https://github.com/github_username/WebChatO.git
  3. Set Environmental Variables :

    export dbName=<Database name>
    export password=<Database password>
    export username=<Database username>
    export host=<Database host>
    export SECRET=<A secret word>

    Note: Replace each value with your own

  4. Edit the .flaskenv to your likening

  5. Start the server:

    flask run

(back to top)

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • File Sharing
  • Profile Page
  • Dynamic Nature
    • Create and Join Room
    • Video Calls
    • Private Dms

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Agbero From PhilaDEVia - @JoelBlvck2 - chibuikeanozie0@gmail.com

Project Link: https://webchatv1.onrender.com/

(back to top)

Acknowledgments

(back to top)

About


Languages

Language:Python 40.8%Language:Jinja 28.7%Language:HTML 22.9%Language:CSS 5.6%Language:Mako 1.9%Language:Shell 0.1%