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

https://github.com/sohamsshah/restream

A streaming Platform for Researchers 🧐👨‍🎓
https://github.com/sohamsshah/restream

Last synced: about 1 year ago
JSON representation

A streaming Platform for Researchers 🧐👨‍🎓

Awesome Lists containing this project

README

          


REStream


Live Project : https://restream-develop.netlify.app/



## Tech Stack :

- **Frontend:** HTML,CSS,React
- **Backend:** Node, Express
- **Dtabase:** MongoDB
- **Version Control:** Git and GitHub
- **Hosting:** Netlify
- **Code Editor and tools**: VS Code



✨ Welcome to REStream - Streaming Platform for Researchers ✨



## Table of Contents

- Overview
- UI of Website
- Contribution Guideline


## Overview 🔨

REStream is a full stack video streaming platform for researchers which is distraction-free and niche-specific app for budding researchers. Configured features such as follow, like videos, create and add to playlist, browse by categories, search history.

## UI of the Website

| ![Screenshot from 2021-07-04 22-27-28](https://user-images.githubusercontent.com/50510726/148827964-9d9e0fa0-7254-48d3-a520-60831d6a556e.png)| ![Screenshot (62)](https://user-images.githubusercontent.com/50510726/148828326-aea5f38e-3522-446e-bbd5-63ab4a0f3501.png) |
|-|-|
| Login Page | Home Page |
| ![Screenshot (63)](https://user-images.githubusercontent.com/50510726/148828560-8a6c49b8-f10c-4371-b7f2-13be3bce2b7d.png)| ![Screenshot (64)](https://user-images.githubusercontent.com/50510726/148828851-10d7cb8a-0cc7-4fe4-832d-706d8fa0c02a.png) |
| Categories Page | Channels Page|

## Setup Steps

- Go to directory
```
$ cd REStream
```
- Install Dependencies
```
$ npm install
```
- Start LocalHost Server
```
$ npm run start
```






## Contribution Guidelines 🏗

To start contributing, follow the below guidelines:

**1.** Fork [this](https://github.com/sohamsshah/REStream) repository.

**2.** Clone your forked copy of the project.

```
https://github.com/sohamsshah/REStream
```

**3.** Navigate to the project directory :file_folder: .

```
cd REStream
```

**4.** Add a reference(remote) to the original repository.

```
git remote add upstream https://github.com/sohamsshah/REStream.git
```

**5.** Check the remotes for this repository.

```
git remote -v
```

**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

```
git pull upstream main
```

**7.** Create a new branch.

```
git checkout -b
```

**8.** Perfom your desired changes to the code base.

**9.** Track your changes:heavy_check_mark: .

```
git add .
```

**10.** Commit your changes .

```
git commit -m "Relevant message"
```

**11.** Push the committed changes in your feature branch to your remote repo.

```
git push -u origin
```

**12.** To create a pull request, click on `compare and pull requests`.

**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.

**14.** Click on `Create Pull Request`.

**15** You did it! 🥳 Wait for your submission to be accepted and your PR to be merged.