open-index/open-npm huggingface dataset:
npm package: @static-styled-plugin/compiler
Description: A plugin that makes styled-components zero-runtime.
Author: Tokky0425
Latest version: 0.3.2

# static-styled-plugin

A plugin that makes styled-components zero-runtime.

## Plugins

- @static-styled-plugin/webpack-plugin
- @static-styled-plugin/vite-plugin
- @static-styled-plugin/next-plugin
npm package: @static-styled-plugin/next-plugin
Description: A plugin that makes styled-components zero-runtime.
Author: Tokky0425
Latest version: 0.3.2

# static-styled-plugin

A plugin that makes styled-components zero-runtime.

## Installation

```sh
npm install @static-styled-plugin/next-plugin
```

## Setup

```js
// next.config.mjs
import { withStaticStyled } from '@static-styled-plugin/next-plugin'

const nextConfig = {
  compiler: {
    styledComponents: true,
  },
}

export default withStaticStyled({
  themeFilePath: './app/theme.ts'
})(nextConfig)
```
npm package: @static-styled-plugin/vite-plugin
Description: A plugin that makes styled-components zero-runtime.
Author: Tokky0425
Latest version: 0.3.2

# static-styled-plugin

A plugin that makes styled-components zero-runtime.

## Installation

```sh
npm install @static-styled-plugin/vite-plugin
```

## Setup

```js
// vite.config.js
import { staticStyled } from '@static-styled-plugin/vite-plugin'

export default defineConfig({
  plugins: [react(), staticStyled({ themeFilePath: './src/theme.ts' })],
})
```
npm package: @static-styled-plugin/webpack-plugin
Description: A plugin that makes styled-components zero-runtime.
Author: Tokky0425
Latest version: 0.3.2

# static-styled-plugin

A plugin that makes styled-components zero-runtime.

## Installation

```sh
npm install @static-styled-plugin/webpack-plugin
```

## Setup

```js
// webpack.config.js
const { StaticStyledPlugin } = require('@static-styled-plugin/webpack-plugin')

module.exports = {
  plugins: [
    new StaticStyledPlugin({ themeFilePath: './src/theme.ts' }),
  ]
}
```

⚠️ **Note**: You need to setup loaders that can handle `.css` files, such as `css-loader` and `style-loader`, as well.
npm package: @staticbackend/cli
Description: StaticBackend's CLI including local dev server
Author: Focus Centric inc.
Latest version: 1.6.1

# StaticBackend's CLI


This CLI allows you to test all the services offered at 
[StaticBackend](https://staticbackend.dev).

It can be used to manage your resources like your database, forms, 
and your account.

[Here's how to get started](https://staticbackend.dev/getting-started/cli/) 
with the CLI.

## Quick install via NPM

```shell
$> npm install -g @staticbackend/cli
$> backend help
```

## Some commands

Start the development server:

```shell
$> backend server
```

List documents in a repository named `tasks`

```shell
$> backend db list tasks
```
npm package: @staticcms/proxy-server
Description: Proxy server to be used with Static CMS proxy backend
Latest version: 4.0.4

# Static CMS Proxy Server

Static CMS Proxy Server is an express server created to facilitate local development.

## How It Works

1. Navigate to a local Git repository configured with the CMS.
2. Run `npx @staticcms/proxy-server` from the root directory of the above repository.
3. Update your `config.yml` to connect to the server:

```yaml
backend:
  name: proxy
  proxy_url: http://localhost:8081/api/v1
  branch: master # optional, defaults to master
```

4. Start you local development server.

## Custom Configuration

1. Create a `.env` file in the root directory of your local Git repository.
2. Update the file as follows:

```bash
# optional, defaults to current directory
GIT_REPO_DIRECTORY=FULL_PATH_TO_LOCAL_GIT_REPO
# optional, defaults to 8081
PORT=CUSTOM_PORT
```
npm package: @staticcms/proxy-server-lite
Description: Proxy server to be used with Static CMS proxy backend
Latest version: 1.0.0

# Static CMS Proxy Server

Static CMS Proxy Server is an express server created to facilitate local development.

## How It Works

1. Navigate to a local Git repository configured with the CMS.
2. Run `npx @staticcms/proxy-server` from the root directory of the above repository.
3. Update your `config.yml` to connect to the server:

```yaml
backend:
  name: proxy
  proxy_url: http://localhost:8081/api/v1
  branch: master # optional, defaults to master
```

4. Start you local development server.

## Custom Configuration

1. Create a `.env` file in the root directory of your local Git repository.
2. Update the file as follows:

```bash
# optional, defaults to current directory
GIT_REPO_DIRECTORY=FULL_PATH_TO_LOCAL_GIT_REPO
# optional, defaults to 8081
PORT=CUSTOM_PORT
```
npm package: @staticdeploy/app-config
Description: Configuration for static apps
Author: Paolo Scanferla
Latest version: 2.0.2

[![npm version](https://img.shields.io/npm/v/@staticdeploy/app-config.svg)](https://www.npmjs.com/package/@staticdeploy/app-config)
[![build status](https://img.shields.io/circleci/project/github/staticdeploy/app-config.svg)](https://circleci.com/gh/staticdeploy/app-config)
[![coverage status](https://codecov.io/github/staticdeploy/app-config/coverage.svg?branch=master)](https://codecov.io/github/staticdeploy/app-config?branch=master)
[![dependency status](https://david-dm.org/staticdeploy/app-config.svg)](https://david-dm.org/staticdeploy/app-config)
[![devDependency status](https://david-dm.org/staticdeploy/app-config/dev-status.svg)](https://david-dm.org/staticdeploy/app-config#info=devDependencies)

# app-config

A tool for generating configuration files for static apps.

### Install

```
yarn add @staticdeploy/app-config
```

### Quickstart

- add the following `<script>` to your `public/index.html`:

  ```html
  <script id="app-config" src="http://localhost:3456/app-config.js"></script>
  ```

- access the config variable in your code:
  ```js
  console.log(window.APP_CONFIG.MY_VAR);
  ```

Then:

#### In development

- define configuration in the `.env` file:

  ```sh
  APP_CONFIG_MY_VAR=my_val
  ```

- start the development server with `$(npm bin)/dev-config-server`

#### In production

- build your app and get the path of the app's `index.html` (for example, for
  apps built with
  [create-react-app](https://github.com/facebookincubator/create-react-app) the
  path is `build/index.html`)

- defining configuration via environment variables:

  ```sh
  export APP_CONFIG_MY_VAR=my_val
  ```

- inject the configuration into the index file by running:
  ```sh
  $(npm bin)/inject-config --file path/to/index.html
  ```

### Additional documentation

- [how `window.APP_CONFIG` is generated](docs/config-generation.md)
- [`inject-config` cli options](docs/inject-config-cli-options.md)
- [`dev-config-server` cli options](docs/dev-config-server-cli-options.md)
npm package: @staticdeploy/app-server
Description: Serve and apply runtime configuration to static apps
Author: Paolo Scanferla
Latest version: 4.1.0

[![npm version](https://img.shields.io/npm/v/@staticdeploy/app-server.svg)](https://www.npmjs.com/package/@staticdeploy/app-server)
[![build status](https://img.shields.io/circleci/project/github/staticdeploy/app-server.svg)](https://circleci.com/gh/staticdeploy/app-server)
[![coverage status](https://codecov.io/github/staticdeploy/app-server/coverage.svg?branch=master)](https://codecov.io/github/staticdeploy/app-server?branch=master)
[![dependency status](https://david-dm.org/staticdeploy/app-server.svg)](https://david-dm.org/staticdeploy/app-server)
[![devDependency status](https://david-dm.org/staticdeploy/app-server/dev-status.svg)](https://david-dm.org/staticdeploy/app-server#info=devDependencies)

# app-server

A tool to serve and apply runtime configuration to static apps.

This tool was created to allow
[create-react-app](https://github.com/facebook/create-react-app) apps to be
configured at runtime (serve-time) via environment variables, making them easily
"dockerizable". It can however be used to serve and configure any static app.

### Install

```
yarn add -D @staticdeploy/app-server
```

### Guides

- [usage with create-react-app](docs/usage-with-cra.md)
- [deploy create-react-app apps with Docker](docs/deploy-cra-apps-with-docker.md)
- [deploy generic static apps with Docker](docs/deploy-apps-with-docker.md)
- [serving assets with custom headers](docs/serving-assets-with-custom-headers.md)

### Reference documentation

- [app-server config options](docs/app-server-config-options.md)
- [how requests are routed](docs/requests-routing.md)
npm package: @staticdeploy/cli
Description: CLI tool for StaticDeploy
Author: Paolo Scanferla
Latest version: 0.15.5

# @staticdeploy/cli

CLI tool to create and deploy bundles.

## Install

```sh
npm i -g @staticdeploy/cli
```

## Use

- `staticdeploy bundle`: creates a bundle and uploads it to the StaticDeploy
  server. Options:

  - `--config` (optional): specify the file from which to load options. Defaults
    to `staticdeploy.config.js`
  - `--apiUrl`: URL of the StaticDeploy management API
  - `--apiToken`: authentication token for the management API
  - `--from`: path of the directory to create the bundle from
  - `--name`: name of the bundle
  - `--tag`: tag of the bundle
  - `--description`: description of the bundle
  - `--fallbackAssetPath` (optional): absolute path (relative to the `from`
    directory) of the asset to use as fallback when requests don't match any
    other asset. Defaults to `/index.html`, but the asset MUST exist
  - `--fallbackStatusCode` (optional): status code to use when serving the
    fallback asset. Defaults to `200`
  - `--headers` (optional): `(asset matcher, headers)` map specifying which
    headers to assign to which assets

- `staticdeploy deploy`: deploys a bundle to an entrypoint. Options (all
  required):

  - `--config` (optional): specify the file from which to load options. Defaults
    to `staticdeploy.config.js`
  - `--apiUrl`: URL of the StaticDeploy API
  - `--apiToken`: authentication token for the API
  - `--bundle`: name:tag combination of the bundle to deploy
  - `--entrypoint`: urlMatcher of the entrypoint to deploy to
  - `--app`: name of the app the entrypoint links to

A valid config file has the following structure:

```js
module.exports = {
  // Optional
  bundle: {
    // Options for the bundle command as specified above
  },
  // Optional
  deploy: {
    // Options for the deploy command as specified above
  }
};
```

Options can also be passed as upper-cased, snake-cased, environment variables
prefixed by `STATICDEPLOY_`. Eg:

```sh
export STATICDEPLOY_API_URL=...
export STATICDEPLOY_API_TOKEN=...
```

Option sources have the following priority:

1.  command line flags
2.  environment variables
3.  configuration defined in the config file

Meaning for example that when an option is provided both as a command line flag
and as an environment variable, the value provided with the command line flag is
used.
npm package: @staticdeploy/http-adapters
Description: Adapters implementing an http API for StaticDeploys' core usecases
Author: Paolo Scanferla
Latest version: 0.15.5

# @staticdeploy/http-adapters

This module contains the adapters that implement an http API for StaticDeploy's
core usecases:

- **management-api-adapter**: RESTful API for usecases managing StaticDeploy
  entities
- **static-server-adapter**: http API for the `RespondToEndpointRequest` usecase
npm package: @staticdeploy/mock-server
Description: Easy to use, no frills mock server
Author: Paolo Scanferla
Latest version: 3.0.0

[![npm version](https://img.shields.io/npm/v/@staticdeploy/mock-server.svg)](https://www.npmjs.com/package/@staticdeploy/mock-server)
[![build status](https://img.shields.io/circleci/project/github/staticdeploy/mock-server.svg)](https://circleci.com/gh/staticdeploy/mock-server)
[![coverage status](https://codecov.io/github/staticdeploy/mock-server/coverage.svg?branch=master)](https://codecov.io/github/staticdeploy/mock-server?branch=master)
[![dependency status](https://david-dm.org/staticdeploy/mock-server.svg)](https://david-dm.org/staticdeploy/mock-server)
[![devDependency status](https://david-dm.org/staticdeploy/mock-server/dev-status.svg)](https://david-dm.org/staticdeploy/mock-server#info=devDependencies)

# mock-server

Easy to use, no frills http mock server.

Suppose you're developing a frontend app that talks to one or more API services.
When running it locally - in your development environment - you need to somehow
provide those services to the app: you can either rely on a remote deployment,
start the services locally, or mock them.

`mock-server` is a command line tool that helps you take the third approach,
allowing you to easily create and run a mock http server to run during
development ([and not only!](docs/recipes/mocking-for-selenium-tests.md)).

### Install

```sh
npm i --save-dev @staticdeploy/mock-server
```

### Quickstart

- create a directory `mock-server`
- create your first handler file `mock-server/get.js`
  ```js
  module.exports = (req, res) => res.send("OK");
  ```
- start the mock server
  ```sh
  $ node_modules/.bin/mock-server
  ```
- call the mocked route
  ```sh
  $ curl http://localhost:3456/
  ```

You add routes to the mock server by adding handler files at the corresponding
path under the `mock-server` directory. Example:

```
mock-server
├── get.js -> handler for GET /
└── users
    ├── {userId}
    |   ├── get.js -> handler for GET /users/1
    |   └── put.js -> handler for PUT /user/1
    ├── get.js -> handler for GET /users
    └── post.js -> handler for POST /users
```

### Documentation

- [user guide](docs/user-guide.md)
- [why you should use `mock-server`](docs/why-use-mock-server.md)
- [validating requests and responses](docs/validation.md)
- recipes:
  - [writing handler files in a compile-to-js language](docs/recipes/using-compile-to-js-languages.md)
  - [mocking a graphql server](docs/recipes/mocking-a-graphql-server.md)
  - [mocking for selenium tests](docs/recipes/mocking-for-selenium-tests.md)
- examples:
  - [react app](examples/react-app)
  - [selenium tests](examples/selenium-tests)
npm package: @staticdeploy/sdk
Description: Browser and nodejs sdk for the StaticDeploy API
Author: Paolo Scanferla
Latest version: 0.15.5

# @staticdeploy/sdk

Browser and nodejs SDK for the StaticDeploy API.

## Install

```sh
yarn add @staticdeploy/sdk
```

## Quickstart

```ts
import StaticdeployClient from "@staticdeploy/sdk";

const client = new StaticdeployClient({
  apiUrl: process.env.STATICDEPLOY_API_URL,
  apiToken: process.env.STATICDEPLOY_API_TOKEN
});

/* In some async function... */

const apps = await client.apps.getAll();
console.log(apps);

const createdApp = await client.apps.create({ name: "my-app" });
console.log(createdApp);
```
npm package: @staticdeploy/storage
Description: staticdeploy storage module
Author: Paolo Scanferla
Latest version: 0.11.1

# @staticdeploy/storage

Module proxying access to storage resources. The module is used by the
**api-server**, which uses it to read from and write to the storage, and by the
**static-server**, which uses it to read from the storage.

Currently StaticDeploy uses S3 (or any API compatible alternative) to store
static files, and either [SQLite](https://www.sqlite.org/) ot
[PostgreSQL](https://www.postgresql.org/) to store metadata about the files, as
well as the other entities of StaticDeploy.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).
npm package: @staticfuse/gatsby-theme-docs
Description: A simple markdown documentation Gatsby Theme. Optimized for simple integration with the Static Fuse Publisher Gatsby Theme.
Author: StaticFuse
Latest version: 0.9.3

# Gatsby Theme Static Fuse Docs

A simple markdown documentation Gatsby Theme. Optimized for simple integration with the Static Fuse Publisher Gatsby Theme.

# Getting Started

Add the following to your `gatsby-config.js`
```javascript
  plugins: [
     '@staticfuse/gatsby-theme-docs',
     // more plugins...
  ]
```

The plugin will create the following directories & files the next time you bootstrap Gatsby:

```javascript
./config/TOC.yml // Docs menu config
./content/assets/ // Optionally use to store assets when writing markdown
./content/docs/getting-started.md // Starter markdown doc. Place additional docs as children here.
```

# Configuring the "aside" docs menu

Menu configuration is administered by editing the `./config/TOC.yml` file.
```yaml
- label: Getting Started # link text
  path: /docs/getting-started # link href value
  isHeader: false # Am I a header? (not a link at all)

  # Example of a header with child links
- label: Section Three (just a header)
  path: /docs/getting-started
  isHeader: true
  childItems: #child link items.
    - label: child link one
      path: /docs/section-three-article-one
      isHeader: false
    - label: child link two
      path: /docs/section-three-article-two
      isHeader: false
```