Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@bhargavmodak
bhargavmodak authored Apr 9, 2024
1 parent f0e5567 commit b0dfe6a
Showing 1 changed file with 40 additions and 62 deletions.
102 changes: 40 additions & 62 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<summary>List of Contents</summary>

- [ Dev Chat +](#-dev-chat-)
- [Try it out!](#try-it-out)
- [Features](#features)
- [Base Features](#base-features)
- [Chat](#chat)
Expand All @@ -16,11 +17,15 @@
- [Code](#code)
- [Call](#call)
- [Draw](#draw)
- [Installation](#installation)
- [Server](#server)
- [Client](#client)
- [Usage](#usage)
- [Technologies Used](#technologies-used)
- [Screenshots](#screenshots)
- [Home Page](#home-page)
- [Chat](#chat-1)
- [Meet](#meet-1)
- [Workspaces](#workspaces-1)
- [Code](#code-1)
- [Call](#call-1)
- [Draw](#draw-1)
- [Attribution](#attribution)
- [Contributing](#contributing)
- [Project Maintainers](#project-maintainers)
Expand All @@ -29,7 +34,11 @@

---

## Features
## Try it out! 💻

**[dev-chat-plus.netlify.app](https://dev-chat-plus.netlify.app/)** ↗️

## Features 🤩

### Base Features

Expand Down Expand Up @@ -59,86 +68,55 @@ Workspaces are tools for collaborating on projects. Each workspace has its own c
#### Draw
- Collaborative whiteboard for drawing and diagramming
- Real-time updates and multiple users can draw simultaneously
- Export drawings as images or PDFs
- Export drawings as PNG images

---

## Installation

- This project was built with `create-react-app`, so you'll need to have [Node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) installed on your machine to run it.
- Check out [How to Install Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for instructions on how to install them.
- Once you have those installed, you can follow these steps to get the project up and running:

1. Clone this repository to your local machine. [Cloning a repository ↗️](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
2. Navigate to the project directory in your terminal. [Navigating the command line ↗️](https://www.digitalcitizen.life/command-prompt-how-use-basic-commands/)

- Note that you will also need to obtain the [environment variables](https://kinsta.com/knowledgebase/what-is-an-environment-variable/) for the server and client in order to run the project. To do this, please contact one of the project maintainers listed below.
- Add the environment variables to a `.env` file in the server and client directories. The file structure should look like this:
## Technologies Used 🔧

```
dev-call
├── client
│ ├── .env
│ ├── package.json
│ └── ...
├── server
│ ├── .env
│ ├── package.json
│ └── ...
└── ...
```

#### Server

1. Navigate to the `server` directory.
2. Run `npm install` to install the project's dependencies.
3. Run `npm run dev` to start the development server.

#### Client

1. In a separate terminal, navigate to the `client` directory.
2. Run `npm install` to install the project's dependencies.
3. Run `npm run start` to start the development server.
| | Technologies |
| -------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Frontend | [React](https://reactjs.org/), [Material-UI](https://material-ui.com/), [Firebase](https://firebase.google.com/), [Socket.io](https://socket.io/), [Github Actions](https://github.com/features/actions), [Netlify](https://www.netlify.com/) |
| Backend | [Firebase](https://firebase.google.com/) Firestore, Firebase Storage (for images), Jitsi Meet SDKs, [Render](https://render.com/) |
| Database | [Firebase](https://firebase.google.com/) Firestore |
| APIs | [Judge0](https://judge0.com/) for code interpreting |

---

## Usage

Once you have the project running, you can access it by navigating to `http://localhost:3000` in your web browser. From there, you can use the chat, meet, and workspace features to collaborate with others on your projects.
## Screenshots 🖼️

**If you are using *Brave Browser*, you may need to disable the built-in shields in order to use the Google Login services. To do this, click on the Brave icon in the top-right corner of the browser and toggle the shields off.**

If you encounter any issues or have any questions, please don't hesitate to reach out to the project maintainers listed below.

---

## Technologies Used
<details>
<summary>Click to view</summary>

### Home Page
![image of home page](https://github.com/Evozone/dev-call/assets/82528318/cba0fb9b-aa21-4086-bcdd-75488c9a83f5)

| | Technologies |
| -------- | :-----------------------------------------------------------------------------------------------------------------------------------------------: |
| Frontend | [React](https://reactjs.org/), [Material-UI](https://material-ui.com/), [Firebase](https://firebase.google.com/), [Socket.io](https://socket.io/) |
| Backend | [Firebase](https://firebase.google.com/) Firestore, Firebase Storage (for images), Jitsi Meet SDKs |
| Database | [Firebase](https://firebase.google.com/) Firestore |
| APIs | [Judge0](https://judge0.com/) for code interpreting |
### Chat
![image of chat](https://github.com/Evozone/dev-call/assets/82528318/ec403a4c-786b-41dd-8478-2436c84d64fd)

---
### Meet
![image of meet](https://github.com/Evozone/dev-call/assets/82528318/2c799fab-4ad3-4f88-80a8-0ea9d1343eec)

### Workspaces
![image of workspace](https://github.com/Evozone/dev-call/assets/82528318/40a61f0e-44c7-492e-9864-d57aa558cb25)
</details>

## Attribution
## Attribution 📜
- [the icon "loading" is provided by loading.io](https://loading.io/icon/)
- Logo Inspiration by [DALLE](https://labs.openai.com) (Generated by [Project Maintainer](https://github.com/TheBrahmnicBoy) via custom prompt)
- Default Background by [DALLE](https://labs.openai.com) (Generated by [Project Maintainer](https://github.com/TheBrahmnicBoy) via custom prompt)

---

## Contributing
## Contributing 🤝

Thank you for your interest in contributing to this project! At this time, we are not accepting pull requests from external contributors. However, we appreciate your support and welcome any feedback or suggestions you may have. If you have any questions or concerns, please feel free to reach out to us below.

---

## Project Maintainers
## Project Maintainers 👷‍♂️👷‍♀️

| <a href="https://github.com/TheBrahmnicBoy"><img alt="Bhargav Modak" src="https://avatars.githubusercontent.com/u/82528318?v=4" width="130px;"><br><sub><b>Bhargav Modak</b></sub></a> | <a href="https://github.com/vishal-codes"><img alt="Vishal Shinde" src="https://avatars.githubusercontent.com/u/79784161" width="130px;"><br><sub><b>Vishal Shinde</b></sub></a> |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| <a href="mailto:thebrahmnicboy@gmail.com">E-Mail ↗️</a> | <a href="mailto:itsvishal2417.com">E-Mail ↗️</a> |
| [![Twitter](https://img.shields.io/badge/twitter-%2300acee.svg?&style=for-the-badge&logo=twitter&logoColor=white&alt=twitter)](https://twitter.com/thebrahmnicboy) | [![Twitter](https://img.shields.io/badge/twitter-%2300acee.svg?&style=for-the-badge&logo=twitter&logoColor=white&alt=twitter)](https://twitter.com/vishaltwts) |
| [![Twitter](https://img.shields.io/badge/twitter-%2300acee.svg?&style=for-the-badge&logo=twitter&logoColor=white&alt=twitter)](https://twitter.com/thebrahmnicboy) | [![Twitter](https://img.shields.io/badge/twitter-%2300acee.svg?&style=for-the-badge&logo=twitter&logoColor=white&alt=twitter)](https://twitter.com/vishaltwts) |

0 comments on commit b0dfe6a

Please sign in to comment.