Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ladunjexa/nextjs14-zoom

Yoom is a video conferencing application built with Next.js, Tailwind CSS, Clerk, and GetStream. 🎦
https://github.com/ladunjexa/nextjs14-zoom

clerk getstream-io react-datepicker shadcn-ui typescripted-nextjs14 zoom-clone

Last synced: 11 days ago
JSON representation

Yoom is a video conferencing application built with Next.js, Tailwind CSS, Clerk, and GetStream. 🎦

Awesome Lists containing this project

README

        

# Next.js 14 Yoom (Zoom Clone)

[![Latest release](https://img.shields.io/github/v/release/ladunjexa/nextjs14-zoom?label=Latest%20release&style=social)](https://github.com/ladunjexa/nextjs14-zoom/releases/tag/v0.1.0)
[![Stars](https://img.shields.io/github/stars/ladunjexa/nextjs14-zoom?style=social)](https://github.com/ladunjexa/nextjs14-zoom/stargazers)
[![Fork](https://img.shields.io/github/forks/ladunjexa/nextjs14-zoom?style=social)](https://github.com/ladunjexa/nextjs14-zoom/forks)
[![GitHub commits](https://img.shields.io/github/commit-activity/t/ladunjexa/nextjs14-zoom?style=social&logo=github)](https://github.com/ladunjexa/nextjs14-zoom/commits)
[![Pull requests](https://img.shields.io/github/issues-pr/ladunjexa/nextjs14-zoom?style=social&logo=github)](https://github.com/ladunjexa/nextjs14-zoom/pulls)

![demo](https://i.ibb.co/SXB6XpF/317983098-f09a8421-67d3-45ce-b9bc-a791cdc2774b.png)

[![ladunjexa](https://custom-icon-badges.demolab.com/badge/made%20by%20-ladunjexa-556bf2?logo=github&logoColor=white&labelColor=101827)](https://github.com/luadnjexa)
[![License](https://img.shields.io/github/license/ladunjexa/nextjs14-zoom?color=dddddd&labelColor=000000)](https://github.com/ladunjexa/nextjs14-zoom/blob/main/LICENSE)
[![Top Language](https://img.shields.io/github/languages/top/ladunjexa/nextjs14-zoom?logo=github&logoColor=%23007ACC&label=TypeScript)](https://www.typescriptlang.org/)
[![Contributors](https://img.shields.io/github/contributors/ladunjexa/nextjs14-zoom?style=flat&color=orange&label=Contributors)](https://github.com/ladunjexa/nextjs14-zoom/graphs/contributors)
![Release](https://img.shields.io/github/release/ladunjexa/nextjs14-zoom.svg)
![PRs](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=shields)
![deployment](https://img.shields.io/github/deployments/ladunjexa/nextjs14-zoom/Production?logo=vercel&label=Website)
[![Known Vulnerabilities](https://snyk.io/test/github/ladunjexa/nextjs14-zoom/badge.svg)](https://snyk.io/test/github/ladunjexa/nextjs14-zoom)

## 🌐 Live Demo

Explore the live demonstration of the project: [nextjs14-zoom](https://nextjs14-zoom.vercel.app/)

## 📝 Description

**Yoom** is a video conferencing application built with Next.js, Tailwind CSS, Clerk, and GetStream.
It allows users to create and join video meetings, schedule meetings, and view upcoming and previous
meetings. The application is built with a modern design and user-friendly interface.

Folder Structure

```bash
nextjs14-zoom/
├── app/
│ ├── (auth)/
│ │ ├── sign-in/
│ │ │ └── [[...sign-in]]/
│ │ │ └── page.tsx
│ │ └── sign-up/
│ │ └── [[...sign-up]]/
│ │ └── page.tsx
│ ├── (root)/
│ │ ├── (home)/
│ │ │ ├── layout.tsx
│ │ │ ├── page.tsx
│ │ │ ├── personal-room/
│ │ │ │ └── page.tsx
│ │ │ ├── previous/
│ │ │ │ └── page.tsx
│ │ │ ├── recordings/
│ │ │ │ └── page.tsx
│ │ │ └── upcoming/
│ │ │ └── page.tsx
│ │ ├── layout.tsx
│ │ └── meeting/
│ │ └── [id]/
│ │ └── page.tsx
│ ├── favicon.ico
│ ├── globals.css
│ └── layout.tsx
├── components/
│ ├── home-card.tsx
│ ├── layout/
│ │ ├── mobile-nav.tsx
│ │ ├── navbar.tsx
│ │ └── sidebar.tsx
│ ├── loader.tsx
│ ├── meeting-modal.tsx
│ ├── meeting-room.tsx
│ ├── meeting-setup.tsx
│ ├── meeting-type-list.tsx
│ └── ui/
│ ├── button.tsx
│ ├── dialog.tsx
│ ├── sheet.tsx
│ ├── toast.tsx
│ ├── toaster.tsx
│ └── use-toast.ts
├── constants/
│ └── index.ts
├── hooks/
│ └── use-get-call-by-id.ts
├── lib/
│ └── utils.ts
├── actions/
│ └── stream.actions.ts
├── providers/
│ └── stream-client-provider.tsx
├── public/
│ ├── icons/[[...]].svg
│ ├── images/[[...]].{jpeg,png}
│ ├── next.svg
│ └── vercel.svg
├── .env.local
├── .eslintignore
├── .eslintrc.json
├── .gitignore
├── .prettierignore
├── .prettierrc
├── components.json
├── middleware.ts
├── next-env.d.ts
├── next.config.mjs
├── package-lock.json
├── package.json
├── postcss.config.mjs
├── README.md
├── tailwind.config.ts
└── tsconfig.json
```

## 📖 Table of Contents

Table of Contents

- [Live Demo](#-live-demo)
- [Description](#-description)
- [Technologies Used](#-technologies-used)
- [Get Started](#-get-started)
- [Prerequisites](#-prerequisites)
- [Installation and Run Locally](#-installation-and-run-locally)
- [Scripts](#-scripts)
- [Environment Variables](#-environment-variables)
- [Deployment](#-deployment)
- [Deploy to production (manual)](#-deploy-to-production-manual)
- [Deploy on Vercel (recommended)](#-deploy-on-vercel-recommended)
- [Deploy on Netlify](#-deploy-on-netlify)
- [Contributing](#-contributing)
- [Bug / Feature Request](#-bug--feature-request)
- [Acknowledgements](#-acknowledgements)
- [Contact Us](#-contact-us)
- [License](#-license)

## ✨ Technologies Used

Yoom is built using the following technologies:

- [TypeScript](https://www.typescriptlang.org/): TypeScript is a typed superset of JavaScript that
compiles to plain JavaScript.
- [Next.js](https://nextjs.org/): Next.js is a React framework for building server-side rendered and
statically generated web applications.
- [Tailwind CSS](https://tailwindcss.com/): Tailwind CSS is a utility-first CSS framework for
rapidly building custom user interfaces.
- [ESLint](https://eslint.org/): ESLint is a static code analysis tool for identifying problematic
patterns found in JavaScript code.
- [Prettier](https://prettier.io/): Prettier is an opinionated code formatter.
- [Clerk](https://clerk.dev/): Clerk is a developer-first authentication API that handles all the
logic for user sign up, sign in, and more.
- [Shadcn-UI](https://ui.shadcn.com/): Shadcn UI is a React UI library that helps developers rapidly
build modern web applications.
- [React Datepicker](https://reactdatepicker.com/): React Datepicker is a simple and reusable
datepicker component for React.
- [Vercel](https://vercel.com/): Vercel is a cloud platform for frontend developers, providing the
frameworks, workflows, and infrastructure to build a faster, more personalized Web.


[![Technologies Used](https://skillicons.dev/icons?i=ts,nextjs,tailwind,vercel)](https://skillicons.dev)

## 🧰 Get Started

To get this project up and running in your development environment, follow these step-by-step
instructions.

### 📋 Prerequisites

In order to install and run this project locally, you would need to have the following installed on
your local machine.

- [Node.js](https://nodejs.org/en/)
- [NPM](https://www.npmjs.com/get-npm)
- [Git](https://git-scm.com/downloads)

### ⚙️ Installation and Run Locally

**Step 0:**

> [!IMPORTANT]
>
> - the application uses Clerk for Authentication and User Management, therefore, you need to create
> Clerk account [here](https://clerk.dev/) and sets the `CLERK_PUBLISHABLE_KEY` and
> `CLERK_SECRET_KEY` environment variables in `.env` file. Also, the different URLs for the Clerk
> sign-in, sign-up, after sign-in and after sign-up pages.
> - the application uses GetStream for Video & Audio Calls, therefore, you need to create GetStream
> account [here](https://getstream.io/) and sets the `STREAM_APP_ID`, `STREAM_API_KEY`, and
> `STREAM_SECRET_KEY` environment variables in `.env` file.

**Step 1:**

Download or clone this repo by using the link below:

```bash
git clone https://github.com/ladunjexa/nextjs14-zoom.git
```

**Step 2:**

Execute the following command in the root directory of the downloaded repo in order to install
dependencies:

```bash
npm install
```

**Step 3:**

Execute the following command in order to run the development server locally:

```bash
npm run dev
```

**Step 4:**

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### 📜 Scripts

All scripts are defined in the `package.json` file. Here is a list of all scripts:

| Script | Action |
| :-------------- | :------------------------------------------ |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run start` | Start your production site locally |
| `npm run lint` | Run ESLint |

## 🔒 Environment Variables

Environment variables[^10] can be used for configuration. They must be set before running the app.

> [Environment variables](https://en.wikipedia.org/wiki/Environment_variable) are variables that are
> set in the operating system or shell, typically used to configure programs.

**Yoom** uses [Clerk](https://clerk.com) and [GetStream](https://getstream.io) as external services.
You need to create an account on each of these services and get the required credentials to run the
app.

Create a `.env` file in the root directory of the project and add the following environment
variables:

```env
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/

NEXT_PUBLIC_STREAM_APP_ID=
NEXT_PUBLIC_STREAM_API_KEY=

STREAM_SECRET_KEY=

NEXT_PUBLIC_BASE_URL=
```

## 🚀 Deployment

#### Deploy to production (manual)

You can create an optimized production build with the following command:

```bash
npm run build
```

#### Deploy on Vercel (recommended)

The easiest way to deploy this Next.js app is to use the
[Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme).

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fladunjexa%2Fnextjs14-zoom)

#### Deploy on Netlify

You can also deploy this Next.js app with [Netlify](https://www.netlify.com/).

[![Deploy with Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/ladunjexa/nextjs14-zoom)

Check out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

## 🔧 Contributing

[![contributors](https://contrib.rocks/image?repo=ladunjexa/nextjs14-zoom)](https://github.com/ladunjexa/nextjs14-zoom/graphs/contributors)

Contributions are what make the open source community such an amazing place to learn, inspire, and
create. Any contributions you make are **greatly appreciated**.

To fix a bug or enhance an existing module, follow these steps:

1. Fork the repo
2. Create a new branch (`git checkout -b improve-feature`)
3. Make the appropriate changes in the files
4. Commit your changes (`git commit -am 'Improve feature'`)
5. Push to the branch (`git push origin improve-feature`)
6. Create a Pull Request 🎉

### 📩 Bug / Feature Request

If you find a bug (failure of a module to execute its intended function), kindly open an issue
[here](https://github.com/ladunjexa/nextjs14-zoom/issues/new) by including the issue with a title
and clear description.

If you'd like to request a new function, feel free to do so by opening an issue
[here](https://github.com/ladunjexa/nextjs14-zoom/issues/new). Please include sample queries and
their corresponding results.

## 💎 Acknowledgements

I'd like to express my gratitude to the following people who helped me with this project and made it
possible:

- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Shadcn UI](https://ui.shadcn.com/)
- [Clerk](https://clerk.dev/)
- [GetStream](https://getstream.io/)
- [React Datepicker](https://reactdatepicker.com/)
- [Vercel](https://vercel.com/)
- [JavaScript Mastery](https://www.jsmastery.pro/)

## 📞 Contact Us

[![Telegram](https://img.shields.io/badge/Telegram-@ladunjexa-2CA5E0?style=social&logo=telegram&logoColor=000000)](https://t.me/ladunjexa)
[![LinkedIn](https://img.shields.io/badge/LinkedIn-ladunjexa-blue?style=flat&logo=linkedin&logoColor=b0c0c0&labelColor=363D44)](https://www.linkedin.com/in/lironabutbul)
[![Instagram](https://img.shields.io/badge/Instagram-ladunjexa-grey?style=flat&logo=instagram&logoColor=b0c0c0&labelColor=8134af)](https://www.instagram.com/ladunjexa)
[![Discord](https://img.shields.io/badge/Discord-ladunjexa-7289da?style=flat&logo=discord&logoColor=b0c0c0&labelColor=2c2f33)](https://discord.com/users/827996364331810816)

## 📋 License

**Yoom** is open source software [licensed as MIT](https://opensource.org/license/mit/) and is free
to use — See [LICENSE](https://github.com/ladunjexa/nextjs14-zoom/blob/main/LICENSE) for more
details.