Skip to content

Me-legna/Whiskord

Repository files navigation

Whiskord 🐱

A Discord inspired application built with Flask, React/Redux, SQLAlchemy, and SocketIO. Whiskord is a real-time messaging application that allows users to communicate with each other through servers, channels, and direct messages.

✨ Features

  • Servers: Create and join servers for different communities.
  • User login: Secure user authentication and authorization.
  • Channels: Create and join channels for different topics within a server.
  • Direct messages: Send direct messages to other users.
  • Private servers: Create and join private servers for exclusive communication.

⚡ Technologies Used

  • Flask: Backend framework for building web applications.
  • React: Frontend library for building user interfaces.
  • Redux: State management library for React.
  • SQLAlchemy: Object-relational mapper for working with databases.
  • SocketIO: Library for real-time communication between client and server.

🏠 Homepage

📺 Demo

  • add Gif here when complete

🚀 Local Installation

  1. Clone the repository

HTTPS:

git clone https://github.com/Me-legna/Whiskord.git

SSH:

git clone [email protected]:Me-legna/Whiskord.git
  1. Install the dependencies
pipenv install -r requirements.txt
  1. Create a .env file based on the example with proper settings for your development environment
SECRET_KEY= <your secret key>
DATABASE_URL=sqlite:///dev.db
SCHEMA=flask_schema
  1. Get into your pipenv, migrate your database, seed your database, and run your Flask app
pipenv shell
flask db upgrade
flask seed all
flask run
  1. Change into the react-app directory
cd react-app
  1. Install the dependencies
npm install
  1. Start the application
npm start
  1. Navigate to the application in your browser

💻 Usage

To use Whiskord, you need to sign up for an account (or use the demo user). You can then create or join a server. Once you're in a server, you can create or join channels and start communicating with other users.

📝 Documentation

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

✏️ Authors

📋 License

Whiskord is released under the MIT License. See MIT License for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages