8000 GitHub - claudiakosylak/group-discord-clone
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

claudiakosylak/group-discord-clone

Repository files navigation


Logo

Discordia

Discordia is a Discord clone where users can create and join servers to chat with other members in live time.
Explore the docs »

View Live Site · Report Bug · Request Feature

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

About The Project

This project was a group collaboration to clone Discord and its core functionality. The initial MVP was due within just over a week's time. Socket.io is implemented to allow chats to happen in live time.

Feature Highlights:

  • Users can create a server, edit that server's details and delete the server
  • Users can create, edit and delete channels for the servers they own
  • Users can send messages within channels for servers they own or are a part of in real time, and can delete their own messages
  • Users can view all of their existing servers in the left nav bar
  • Users can discover new servers to join, join servers, and leave a server

(back to top)

Built With

  • React
  • Redux
  • Socket.io
  • Flask
  • Python
  • JavaScript
  • AWS
  • HTML5
  • CSS3

(back to top)

Getting Started

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

  1. Clone this repository

  2. Install dependencies

    pipenv install -r requirements.txt
  3. Create a .env file with your environment variables based on this example:

    SECRET_KEY=your_secret_key DATABASE_URL=your_db_url SCHEMA=your_schema_name

    S3_BUCKET=your_bucket_name S3_KEY=your_key S3_SECRET=your_secret_key

  4. 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
  5. To set up the front end, cd into react-app in another terminal. Then install dependencies and start the app:

    npm install
    npm start

(back to top)

Usage

Sign Up

Users can sign in giving their details.

signup

Log In

Registered users can log in with their credentials. Users can also log in with one of two demo users to test functionality without creating an account.

login

Send and Delete Messages

Users can send messages within channels for servers they are a part of. They can also delete messages that they have sent.

send-delete-messages

Create a Server

Users can create a new server and choose a name for that server. A general channel is always automatically created for new servers.

create-server

Edit a Server

Users can edit the name for servers they own.

edit-server

Delete a Server

Users can delete a server that they own. They are prompted to enter the name of the server to match so that they do not delete a server by mistake.

delete-server

Create a Channel

Users can create a channel for servers they own, choosing a name and a topic for that channel.

create-channel

Edit a Channel

Users can edit the details for channels that they own by clicking the cog next to the channel name.

edit-channel

Delete a Channel

Users can delete channels for servers they own by clicking Delete Channel from within the Edit Channel modal.

delete-channel

Discover Servers

Users can go to the discover servers page from either the left navigation bar or the home page upon login. Here they can see all of the servers they are not yet a part of.

discover-servers

Join a Server

Users can join servers from the discover servers page. They are redirected to the server page once they join.

join-server

Leave a Server

Users can leave servers that they are currently members of.

leave-server

(back to top)

Roadmap

  • AWS implementation to be able to upload pictures for server and user icons.
  • Add reactions for messages.
  • Direct messaging between two specific users.

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

(back to top)

Contact

Project Link: https://github.com/claudiakosylak/group-discord-clone

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages

0