Watts-Blake/Discord-proj

Diss-cord Project Clone

Welcome to the Diss-cord Repo, this is a clone of Discord. Diss-cord Project Clone is a web application that allows you to communicate with friends or colleagues through servers, server channels and direct messages.

Table of Content

• Technologies Used
• Link to Live Site
• Index
• Getting Started
  • For M1 Users
  • Standard
• Screenshots of Usage
• Code Snippets

Techonologies Used

Link to Live Site

Diss-cord

Index

[Feature List] | [API Documentation] | [Database Schema] | [User Stories and Acceptance Criteria] | [Front End Routes]

Getting Started

Installing the application (2 ways)

Dev Containers (for M1 uers)

1. Make sure you have the Microsoft Remote - Containers extension installed.

2. Make sure you have Docker installed on your computer.

3. Clone the repository (only this branch)

   git clone https://github.com/Watts-Blake/Discord-proj.git

4. Open the repo in VS Code.

5. Click "Open in Container" when VS Code prompts to open container in the bottom right hand corner.

6. Be Patient! The initial install will take a LONG time, it's building a container that has postgres preconfigured and even installing all your project dependencies. (For both flask and react!)

   Note: This will take much less time on future starts because everything will be cached.

7. Once everything is up, be sure to make a .env file based on .env.example in both the root directory and the react-app directory before running your app.

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

9. To run the React App, install the dependencies in the react-app folder and run the application.

   npm install

   npm start

10. The application will start at http://localhost:3000/.

Standard (Traditional)

1. Clone this repository (only this branch)

   git clone https://github.com/Watts-Blake/Discord-proj.git

2. Install dependencies

   pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt

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

4. Setup your PostgreSQL user, password and database and make sure it matches your .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. To run the React App, install the dependencies in the react-app folder and run the application.

   npm install

   npm start

7. The application will start at http://localhost:3000/.

Screenshots of Usage

Home Page

Sign up page

Login Page

Landing After Login Page

Create Server Pages

Server Discovery Page

Server View

Server Edit Page

Channel Creation Page

Channel Edit Page

Direct Message Page

Thank you for viewing!