open-index/open-npm huggingface dataset:
npm package: @nullserve/cli
Description: Command line tool to interact with the NullServe API
Author: David J. Felix @DavidJFelix
Latest version: 0.0.6

# nullserve-cli

Command line tool to interact with the NullServe API

[![oclif](https://img.shields.io/badge/cli-oclif-informational.svg?style=for-the-badge)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@nullserve/cli.svg?style=for-the-badge&logo=npm)](https://npmjs.org/package/nullserve-cli)
[![Downloads/week](https://img.shields.io/npm/dw/@nullserve/cli.svg?style=for-the-badge&logo=npm)](https://npmjs.org/package/nullserve-cli)
[![License](https://img.shields.io/npm/l/@nullserve/cli.svg?style=for-the-badge&logo=apache)](https://github.com/nullserve/nullserve-cli/blob/master/package.json)

<!-- prettier-ignore-start -->
<!-- toc -->
* [nullserve-cli](#nullserve-cli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
<!-- prettier-ignore-end -->

# Usage

<!-- prettier-ignore -->
<!-- usage -->
```sh-session
$ npm install -g @nullserve/cli
$ nullserve COMMAND
running command...
$ nullserve (-v|--version|version)
@nullserve/cli/0.0.5 darwin-x64 node-v13.11.0
$ nullserve --help [COMMAND]
USAGE
  $ nullserve COMMAND
...
```
<!-- usagestop -->
<!-- prettier-ignore-end -->

# Commands

<!-- prettier-ignore-start -->
<!-- commands -->
* [`nullserve deploy DIRECTORY`](#nullserve-deploy-directory)
* [`nullserve help [COMMAND]`](#nullserve-help-command)
* [`nullserve init`](#nullserve-init)
* [`nullserve login [FILE]`](#nullserve-login-file)

## `nullserve deploy DIRECTORY`

deploy to nullserve

```
USAGE
  $ nullserve deploy DIRECTORY

OPTIONS
  -a, --token=token            the api token used to deploy
  -d, --deployment=deployment  the deployment id to use (skips deployment creation)
  -h, --help                   show CLI help
  -s, --site-slug=site-slug    (required) the site that is being deployed to

EXAMPLE
  $ nullserve deploy
```

_See code: [src/commands/deploy.ts](https://github.com/nullserve/nullserve-cli/blob/v0.0.5/src/commands/deploy.ts)_

## `nullserve help [COMMAND]`

display help for nullserve

```
USAGE
  $ nullserve help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_

## `nullserve init`

initialize a nullserve project

```
USAGE
  $ nullserve init

OPTIONS
  -a, --token=token          the api token used to deploy
  -h, --help                 show CLI help
  -s, --site-slug=site-slug  the site that is being deployed to

EXAMPLE
  $ nullserve init
```

_See code: [src/commands/init.ts](https://github.com/nullserve/nullserve-cli/blob/v0.0.5/src/commands/init.ts)_

## `nullserve login [FILE]`

describe the command here

```
USAGE
  $ nullserve login [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print
```

_See code: [src/commands/login.ts](https://github.com/nullserve/nullserve-cli/blob/v0.0.5/src/commands/login.ts)_
<!-- commandsstop -->
<!-- prettier-ignore-end -->
npm package: @nullserve/react-lib
Description: Made with create-react-library
Author: David J Felix
Latest version: 0.10.0

This project houses a react component library utilized by NullServe React apps.
It acts both as a library and rudimentary design system.

There are 3 primary frameworks in use in this project:

- [Create React Library](https://github.com/transitive-bullshit/create-react-library)
- [Create React App](https://github.com/facebook/create-react-app)
- [StoryBook](https://storybook.js.org/)

Create `React Library` and `Storybook` detect and utilize `Create React App` and to help deliver their independent goals.

# Local Development

It's recommended that storybook be used for local development.
Storybook will allow you to write use cases to visually test and demonstrate a component use case.

`yarn run storybook`

## Libraries in use

NullServe's component system is driven primarily by Chakra UI for style and layout.
While Apollo Client is generally assumed to exist, it isn't brought in by this library or used by any pages at this time.
Formik and Yup are used for form components and validation.
Reach Router is used for routing.

In the future, these dependencies may be moved to a different library and this project may be changed over to a monorepo that houses them, to try to isolate transitive dependencies.
If you're reading this and that sounds like something you want, open a github issue.