Simply

A zoom clone I making to learn full stack development!

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

This is a project I am currently doing to learn more about full stack development, initially I was just going to do a chat website but then decided to create a zoom clone because I wanted to learn about video! I settled on creating this project using the MERN stack. I used a lot of different tools so make sure to checkout the acknowledgments for the tools! In terms of development I first started off with some free figma design templates and then started working on boilerplate frontend. I am currently working on implementing the backend as well as finishing the frontend.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

The project is divided into two sections: the frontend and the backend. To view the full project, you'll need to configure a .env file for the backend. This requires setting up a MongoDB Atlas cluster. Currently the project runs using npm run dev for both front and backend I plan to make this easier in the future.

Prerequisites

First install npm if not installed

• npm

  npm install npm@latest -g

Installation

1. Create a MongoDB Account and set up an Atlas cluster by following the instructions here.

2. Clone the repo

   git clone https://github.com/kevinru2023/simply-

3. Install NPM packages

   npm install

4. Create and config your .env in the backend directory

   PORT="port for frontend"
   PEER_PORT="port for peerserver"
   MONGO_DB="your MongoDB connection string"
   FRONTEND_ORIGIN="your frontend URL"

5. Navigate to backend and start it

   npm run dev

6. Navigate ro frontend and start it

   npm run dev

(back to top)

Usage

With both the backend and frontend now working, go to the URL where your frontend is being hosted (typically localhost:5731 when using Vite) and click Host Room to create a room. Currently, not much can be done from there as I am still very early in the development stage.

(back to top)

Roadmap

• Room Creation
• Chat feature (still need to fix frontend)
• Video call implementation
• User list

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Kevin Rubio - (Linkedin) - kevinru2005@gmail.com

Project Link: https://github.com/kevinru2023/simply

(back to top)

Acknowledgments

• PeerJS
• Shadcn/ui
• SocketIO
• Mongoose
• README template

(back to top)