Skylark Preview

Preview your users' experience on your Skylark powered Streaming app by modifying active Availability Rules directly in Google Chrome.
Learn more »

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
   • Running
3. Contributing
4. License
5. Contact

About The Project

Introducing Skylark Preview, the cutting-edge Google Chrome extension designed for Skylark-powered streaming platforms.

Enhance your content strategy by seamlessly modifying Availability Rules directly on the page.

With Skylark Preview, you gain the ability to preview your users’ experience from anywhere in the world, at any time. Stay one step ahead by planning ahead and ensuring seamless content availability. Unleash the true potential of your streaming platform with Skylark Preview, an indispensable tool for content creators and strategists.

How it works

Once installed and configured with your Skylark credentials, Skylark Preview intercepts requests to your Skylark and modifies its headers.

You are able to:

1. Time Travel in the request, meaning you can preview content that is availabile in the future.
2. Override Availability Dimensions, meaning you can preview how your app appears to any user type available in your Skylark.

---

Getting Started

To set the code up locally for development, follow these steps:

Prerequisites

• Yarn

   npm install -g yarn

• Vercel CLI

   npm install -g vercel@latest

Running

Install the NPM dependencies:

yarn

Run the dev server powered by Vite:

yarn dev

Install the unpacked extension to your Google Chrome by following the instructions here: https://crxjs.dev/vite-plugin/getting-started/vanilla-js/dev-basics#install-the-extension

Using yarn dev means that Vite will be running with Hot Module Reload. Therefore you are free to make changes to the extension and it should reload automatically.

Building

yarn build:all

Publish to Chrome Web Store

1. Build the extension
2. Zip up the dist directory (yarn zip:all or zip -r preview.zip ./dist/chrome/)
3. Follow the instructions on Google to submit it to the Web Store: https://developer.chrome.com/docs/webstore/publish/

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

License

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

Contact

Skylark Support - support@skylarkplatform.com

Project Link: https://github.com/skylark-platform/skylark-preview