@allenai/varnish

Varnish

A beautiful finish for your demo.

Varnish makes it easy to build AI2 branded demos, websites, and applications.

For a preview of what your application will look like by using Varnish, and documentation for getting started, visit https://varnish.allenai.org.

What do I get by using Varnish?

• A theme for both Ant Design and Styled-Components that matches AI2's branding.
• A collection of pre-styled React components that are easy to use and are professional looking.

Some sites that use Varnish:

• Varnish Demo
• Skiff Template
• Computer Vision Explorer
• AllenNLP Demo

Getting Started

You can find documentation for getting started here.

Components

Varnish is built on top of Ant Design. To see a full list of the Varnish specific components visit the demo.

If you don't find what you're looking for, you can use one of the Ant components.

Staying Up to Date

Varnish is changing quickly. To stay up to date as we release new versions, join the #varnish-releases Slack channel.

Helpful Links

Here's a list of resources that might be helpful as you get started:

• TypeScript in 5 minutes
• ReactJS Tutorial
• Ant Design

Getting Help

If you're stuck don't hesitate to reach out:

• Sending an email to [e-mail]
• Opening a Github Issue
• Asking a question in the #skiff-users slack channel.

We're eager to improve Varnish and need your feedback to do so!

Contributing

We welcome and encourage contributions. For more information on how to get your development environment setup, review this document.