Code Monkey home page Code Monkey logo

openstream's Introduction

Screen & Webcam Recorder - OpenStream

More info on how to join this project in this doc: https://docs.google.com/document/d/1Xpya6dcpieb21EmNE0-Mah7I8RzS6q4HO6ayqpE3PU4/

Detailed information regarding this project plan can be found in this doc: https://docs.google.com/document/d/15SNuBZt5T5TQWcdfDaH5MRrNlB_UEXSeflmZHyhFKYQ/


Description

OpenStream is an open-source project for creating a free tool that records screen and webcam footage simultaneously. It's designed for content creators and developed collaboratively through our community on Discord.

Features

  • Popup Interface: Click on the extension icon to open a popup window.
  • Capture Screenshot: Ability to capture a screenshot of the current tab.
  • User Interaction: A minimal user interface to interact with the extension.

Installation

To install this extension in your Chrome browser, follow these steps:

  1. Download or Clone the Repository:: Download this repository to your local machine or use git clone.
  2. Install Dependencies: Run pnpm i
  3. Start Dev Server: Run pnpm dev
  4. Open Chrome Extensions: Go to chrome://extensions/ in your Chrome browser.
  5. Enable Developer Mode: Toggle on the "Developer mode" at the top right of the extensions page.
  6. Load the Extension: Click on "Load unpacked" and select the build/chrome-mv3-dev directory.

Usage

After installation, click on the extension icon in the Chrome toolbar to open the popup window. From there, you can interact with the features provided.

Development

  • This extension uses Plasmo Framework with React and TypeScript.
  • The entry point is popup.tsx (Think of this like main entry point in normal React App).
  • All of the manifest config lives in "manifest" field in package.json.

Contributing

Contributions to this project are welcome. To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature (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.

License

This project is licensed under the MIT License - see the LICENSE file for details.

openstream's People

Contributors

ykdojo avatar jasonetorres avatar mehta-avi avatar omar-shahid avatar pavanmca avatar cbid2 avatar mahir-anand avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.