project_title

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

SatStream is a decentralized video streaming platform that allows users to upload, store, and stream videos. It is built on top of the Filecoin and saturn network and uses the Lighthouse storage protocol as aggregator for retaining the videos on filecoin network as per user requirements. We used tableland as database for storing video metadata and other user information. Using various stacks helped us made completely decentralized video streaming platform.

(back to top)

Built With

• 
• 
• Filecoin
• Lighthouse
• Tableland
• Saturn

(back to top)

Getting Started

This is an example of how you could set up our project locally, initializing backend is tough, you can initialize frontend only as well to get a feel of the project.

Prerequisites

You would need yarn package manager installed on your system. You can go through the installation guide here

Installation

1. Clone the repo

   git clone https://github.com/lordshashank/satStream.git

2. Set up the environment variables using various free api keys as stated in .env.example of both frontend and contracts folder.
3. Initialize the backend

   cd contracts
   yarn install
   yarn hardhat compile
   yarn service

4. Initialize the frontend

   cd ../frontend
    yarn install
    yarn run dev

5. Open the frontend on localhost:3000

(back to top)

Usage

SatStream is an aim to decentralize the video streaming platform. We aim build it as alternative for people who don't want to trust the centralized platforms taking decision on their data and having access to it. We aim to build a platform where users can upload their videos and have complete control over it.

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Shashank Trivedi - @lordshashank

Project Link: https://github.com/lordshashank/SatStream

(back to top)

Acknowledgments

Thanks to all the sponsors and organizers for making this Open Data hackathon possible. Mentors have been helping us, giving reviews with various aspects of the project and we are grateful to them for that.

(back to top)