Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
harshvsri committed Apr 5, 2024
1 parent 4440c86 commit bdba282
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# VideoVault

![Screenshot](https://i.ibb.co/0QYYByk/videovault-screenshot.png)

VideoVault is a dynamic video sharing and streaming platform inspired by YouTube. It allows users to upload, share, and stream videos.

Key features include:

- **Video Uploads:** Users can upload videos in various formats and share them.
- **Streaming:** High-quality streaming capabilities ensure a smooth viewing experience.
- **User Accounts:** Users can create accounts, manage their video uploads.
- **Comments and Likes:** Users can engage with videos by leaving comments and likes.
- **Search and Discovery:** A robust search function allows users to find specific videos.

This project aims to replicate the core functionality of YouTube, providing a platform for learning and experimenting with video hosting and streaming technologies.

## Contribution Guide

If you're a beginner and want to contribute to this project, follow these steps:

1. **Fork the Repository**: Click on the fork button at the top right corner of this page and clone the forked repository to your local machine. This creates a copy of this repository in your account.

```bash
git clone https://github.com/<your-username>/videovault-client.git
```

2. **Client Setup**: After cloning the repository, you need to set up the client:

- **Install Dependencies**: Install the necessary dependencies using npm:

```bash
npm install
```

- **Start the Client**: Once the dependencies are installed, you can start the client using the following command:

```bash
npm run dev
```

3. **Create a New Branch**: Use the `git checkout` command to create a new branch.

```bash
git checkout -b <your-branch-name>
```

4. **Make Changes**: Make your changes in the new branch.

5. **Commit and Push Your Changes**: Once you have made your changes, use the `git add` command to stage your changes for commit. Then, use the `git commit` command to commit your changes.

```bash
git add .
git commit -m "<your-commit-message>"
git push origin <your-branch-name>
```

6. **Create a Pull Request**: Go to your repository on GitHub, you will see a `Compare & pull request` button. Click on that button to create a pull request.

Thank you for your contribution! 🎉

0 comments on commit bdba282

Please sign in to comment.