Skip to content

Latest commit

 

History

History
144 lines (90 loc) · 7.43 KB

README.md

File metadata and controls

144 lines (90 loc) · 7.43 KB
Raw

WELCOME TO DISCORDIA

Discordia is a Discord clone built using Postgres, Flask-SQLAlchemy, React, Redux.

The backend utilizes Flask-SocketIO while the frontend utilizes socket.io-client to set up its websocket connection.

Discordia (discord) is an instant messaging social platform. Users can chat live in servers or private messages.

image

Follow the link below to check it out! https://discordia-cgh.herokuapp.com/

NAVIGATING DISCORDIA

HOW TO LOGIN Login by clicking on the 'Login' button located on the top right. You can also sign up by following the Login button then clicking the 'Register' link located near the bottom-left of the form. Alternatively, there is a sign up button located at the bottom of the home page. Fill out the form and you are now part of the Discordia community! If you're curious and want to check it out without any obligation, feel free to login as a demo user which can be accessed on the login page! image

Logging in

image

Signing Up

image

After logging in or signing up, you will be at your home page where you can navigate to your open direct messages (DMs) and chat with friends.

image

You can navigate to channels by clicking on the servers located on the far left sidebar. From there, you can see each of the server's channels and chat with other users in the server!

image

You can also start DMs with other users in that same server! Just click on on a user on the right sidebar while you're viewing a server.

image

image

You can also create your own server (and channels of course!) by clicking on the green + button below all the servers.

image

As a server owner, you can any of the following:

Edit a server by clicking on your server's name above the channels list and then clicking the server settings button

image

image

Delete your server (why would you want to though??)

image

Create a channel by clicking on the + button to the right of 'TEXT CHANNELS' located aboove all your channels

image

image

Edit a channel by clicking on the cogwheel to the right of your server's channel's name

image

image

Delete a channel (again... why would you want to?)

image

Tech used

Flask Python React Redux Ubuntu JavaScript NodeJS HTML CSS3 Heroku Postgres Docker

To dos

  • Group DMs
  • Invite feature
  • Friends

How to set up

  1. Clone this repository (only this branch)

    git clone [email protected]:nachen98/Discord-Clone.git

  2. Install dependencies

    pipenv install -r requirements.txt

  3. Create a .env file based on the example with proper settings for your development environment

  4. Make sure the SQLite3 database connection URL is in the .env file

  5. 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

  6. From the root directory, cd into react-app, install your dependencies, run npm install, and WALA! You got your very own Discord clone.

    cd react-app
    npm install
    npm start