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/
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.
- 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.
To install this extension in your Chrome browser, follow these steps:
- Download or Clone the Repository:: Download this repository to your local machine or use
git clone. - Install Dependencies: Run
pnpm i - Start Dev Server: Run
pnpm dev - Open Chrome Extensions: Go to
chrome://extensions/in your Chrome browser. - Enable Developer Mode: Toggle on the "Developer mode" at the top right of the extensions page.
- Load the Extension: Click on "Load unpacked" and select the
build/chrome-mv3-devdirectory.
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.
- 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 inpackage.json.
Contributions to this project are welcome. To contribute:
- Fork the repository.
- Create a new branch for your feature (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.