Skylark UI

Curation UI for Skylark
Learn more »

View App · Report Bug · Request Feature

Table of Contents

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

About The Project

Skylark UI is the offical frontend app for Skylark. It provides a user interface that enables users to:

• Import, create, update objects
• Create relationships between objects
• Curate objects into sets
• Assign availability rules to determine which objects are returned
• Modify their Skylark configuration

We made the decision to Open Source the repository so that users are able to take the UI and modify it to fit their needs. This can be anywhere from adding their logo, to crafting new features that are currently missing. All we ask in return is that when you create these features, you raise a pull request so that other users can benefit too!

Additionally, all requests that are made to Skylark from the UI are using the official Skylark GraphQL API meaning you can use this repository as an aid when developing your own Skylark applications. If this sounds like you, you may also want to check out our StreamTV application - a demo Streaming App built on Skylark.

StreamTV: https://github.com/skylark-platform/reference-apps

---

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

Installation

Install the NPM dependencies:

yarn

This should also install the pre-commit hooks.

Next, you need to create a .env or .env.local file so you can to connect to your Skylark account.

There are two ways to do this:

1. Skylark Vercel team member

We can use the Vercel CLI to download environment variables straight from Vercel.

First, connect to the skylark-ui Vercel project

yarn vercel:link

Then we can pull the environment variables from Vercel:

yarn vercel:env

Note: When you use this method, it is likely that the values will change each day. Due to this it is neccessary to re-run the env command each day.

2. Connect to your Skylark

You can use the admin panel in your Skylark account to get the environment variables required to connect.

Coming soon...

Running

To run the Next.js dev server:

yarn dev

To run Storybook:

yarn storybook

Testing

Storybook (Component testing)

Check out our Storybook

We use this to compare diff on a pull request as well as test before they are merged.

Unit tests

We use Jest and React Testing Libary for unit testing. To run use:

yarn test

Integration tests

In the future we plan to use Cypress and Percy for Integration tests.

Deploying

The easiest way to deploy the Skylark UI is using Vercel. Use the Deploy button below to automatically fork this project and create it in Vercel.

Otherwise, as the app is built using Next.js, you can use their documentation to deploy to other platforms:

• Next.js Deployment

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 - [email protected]

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