npm package: @staart/ui
Description: Frontend Svelte app starter for SaaS startups
Author: Anand Chowdhary
Latest version: 3.0.2

[![Staart UI](https://raw.githubusercontent.com/staart/staart.js.org/master/assets/svg/ui.svg?sanitize=true)](https://staart.js.org/ui)

Staart UI is a frontend starter for SaaS startups written in TypeScript and Vue
using Nuxt.js. It has built-in landing pages, authentication, settings UIs, and
more.

|              | Status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Build        | [![GitHub Actions](https://github.com/staart/ui/workflows/Node%20CI/badge.svg)](https://github.com/staart/ui/actions) [![Travis CI](https://img.shields.io/travis/staart/ui?label=Travis%20CI)](https://travis-ci.org/staart/ui) [![Circle CI](https://img.shields.io/circleci/build/github/staart/ui?label=Circle%20CI)](https://circleci.com/gh/staart/ui) [![Azure Pipelines](https://dev.azure.com/staart/ui/_apis/build/status/staart.ui?branchName=master)](https://dev.azure.com/staart/ui/_build/latest?definitionId=1&branchName=master)                                                              |
| Dependencies | [![Dependencies](https://img.shields.io/david/staart/ui.svg)](https://david-dm.org/staart/ui) [![Dev dependencies](https://img.shields.io/david/dev/staart/ui.svg)](https://david-dm.org/staart/ui) ![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/staart/ui.svg)                                                                                                                                                                                                                                                                                                                       |
| Community    | [![Contributors](https://img.shields.io/github/contributors/staart/ui.svg)](https://github.com/staart/ui/graphs/contributors) [![GitHub](https://img.shields.io/github/license/staart/ui.svg)](https://github.com/staart/ui/blob/master/LICENSE) ![Type definitions](https://img.shields.io/badge/types-TypeScript-blue.svg) [![npm package version](https://img.shields.io/npm/v/@staart/ui)](https://www.npmjs.com/package/@staart/ui) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) |

Staart UI is built to work with [Staart](https://github.com/o15y/staart), the
backend starter for SaaS startups.

**⚠️ v2 BETA WARNING:** The master branch and all 2.x releases are currently in beta. For production, use v1.x instead on this commit tree: [`3c8e1e2`](https://github.com/staart/ui/tree/3c8e1e27fd41c7183a5da68f908a457f17ac2a19).

<table>
  <tbody>
    <tr>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/home.png">
      </td>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/login.png">
      </td>
    </tr>
    <tr>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/pricing.png">
      </td>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/profile.png">
      </td>
    </tr>
    <tr>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/members.png">
      </td>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/settings.png">
      </td>
    </tr>
    <tr>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/feedback.png">
      </td>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/billing.png">
      </td>
    </tr>
    <tr>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/2fa.png">
      </td>
      <td>
        <img alt="" src="https://raw.githubusercontent.com/staart/ui/3c8e1e27fd41c7183a5da68f908a457f17ac2a19/static/screenshots/api-key.png">
      </td>
    </tr>
  </tbody>
</table>

## 🛠 Usage

Clone or fork this repository, then install dependencies:

```bash
yarn
```

Start a local development server:

```bash
yarn dev
```

Generate static pages for deployment:

```bash
yarn generate
```

## [📝 Documentation](https://staart.js.org/ui)

- [Getting started](https://staart.js.org/ui/getting-started)
- [Updating Staart UI](https://staart.js.org/ui/update)

## 👥 Contributors

Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table>
  <tr>
    <td align="center"><a href="https://anandchowdhary.com/?utm_source=github&utm_campaign=about-link"><img src="https://avatars3.githubusercontent.com/u/2841780?v=4" width="100px;" alt="Anand Chowdhary"/><br /><sub><b>Anand Chowdhary</b></sub></a><br /><a href="https://github.com/o15y/staart-ui/commits?author=AnandChowdhary" title="Code">💻</a> <a href="https://github.com/o15y/staart-ui/commits?author=AnandChowdhary" title="Documentation">📖</a> <a href="#design-AnandChowdhary" title="Design">🎨</a></td>
    <td align="center"><a href="http://komiserback@gmail.com"><img src="https://avatars3.githubusercontent.com/u/36298335?v=4" width="100px;" alt="reallinfo"/><br /><sub><b>reallinfo</b></sub></a><br /><a href="#design-reallinfo" title="Design">🎨</a></td>
  </tr>
</table>

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!

## [🏁 Staart Ecosystem](https://staart.js.org)

The Staart ecosystem consists of open-source projects to build your SaaS startup, written in TypeScript.

| Package                                                  |                                         |                                                                                                                                                                                                                                                                                                                                                                                                                       |
| -------------------------------------------------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [🛠️ Staart API](https://github.com/staart/api)           | Node.js backend with RESTful APIs       | [![Build status](https://img.shields.io/circleci/build/github/staart/api)](https://circleci.com/gh/staart/api) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fapi.json)](https://staart.js.org/api) [![npm package version](https://img.shields.io/npm/v/@staart/manager)](https://www.npmjs.com/package/@staart/manager)                                                 |
| [🌐 Staart UI](https://github.com/staart/ui)             | Frontend Vue.js Progressive Web App     | [![Build status](https://img.shields.io/circleci/build/github/staart/ui)](https://circleci.com/gh/staart/ui) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fui.json)](https://staart.js.org/ui) [![npm package version](https://img.shields.io/npm/v/@staart/ui)](https://www.npmjs.com/package/@staart/ui)                                                               |
| [📑 Staart Site](https://github.com/staart/site)         | Static site generator for docs/helpdesk | [![Build status](https://img.shields.io/circleci/build/github/staart/site)](https://circleci.com/gh/staart/site) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fsite.json)](https://staart.js.org/site) [![npm package version](https://img.shields.io/npm/v/@staart/site)](https://www.npmjs.com/package/@staart/site)                                                   |
| [📱 Staart Native](https://github.com/staart/native)     | React Native app for Android and iOS    | [![Build status](https://img.shields.io/circleci/build/github/staart/native)](https://circleci.com/gh/staart/native) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fnative.json)](https://staart.js.org/native) [![npm package version](https://img.shields.io/npm/v/@staart/native)](https://www.npmjs.com/package/@staart/native)                                       |
| [🎨 Staart.css](https://github.com/staart/css)           | Sass/CSS framework and utilities        | [![Build status](https://img.shields.io/circleci/build/github/staart/css)](https://circleci.com/gh/staart/css) [![Docs](https://img.shields.io/endpoint?url=https%3A%2F%2Fstaart.js.org%2Fshield-schema%2Fcss.json)](https://staart.js.org/css) [![npm package version](https://img.shields.io/npm/v/@staart/css)](https://www.npmjs.com/package/@staart/css)                                                         |
| [📦 Staart Packages](https://github.com/staart/packages) | Helper functions and utility packages   | [![Build status](https://img.shields.io/circleci/build/github/staart/packages)](https://circleci.com/gh/staart/packages) [![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fservices.anandchowdhary.now.sh%2Fapi%2Fgithub-files%3Frepo%3Dstaart%2Fpackages%26path%3Dpackages%26label%3Dstaart%26message%3D%25241%2524%2520package%2524S%2524%26color%3Dblueviolet)](https://www.npmjs.com/org/staart) |

## 💝 Sponsors

The development of Staart projects is supported by these wonderful companies. [Find us on OpenCollective](https://opencollective.com/staart)

<!-- prettier-ignore -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/OswaldLabsOpenSource"><img src="https://avatars3.githubusercontent.com/u/21421587?v=4" width="100px" alt=""/><br><sub><b>Oswald Labs</b></sub></a></td>
    <td align="center"><a href="https://github.com/O15Y"><img src="https://avatars3.githubusercontent.com/u/48348500?v=4" width="100px" alt=""/><br><sub><b>O15Y</b></sub></a></td>
    <td align="center"><a href="https://github.com/speakupnl"><img src="https://avatars3.githubusercontent.com/u/33686381?v=4" width="100px" alt=""/><br><sub><b>Speakup</b></sub></a></td>
    <td align="center"><a href="https://github.com/netlify"><img src="https://avatars3.githubusercontent.com/u/7892489?v=4" width="100px" alt=""/><br><sub><b>Netlify</b></sub></a></td>
  </tr>
</table>

## 📄 License

- Code: [MIT](https://github.com/staart/ui/blob/master/LICENSE)
- Logo and assets: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)