# nfrush-atomico-base

> a repo to start with atomico

Latest version **0.0.11** (published 2021-11-24) · 0 weekly downloads

## Install

```sh
npm install nfrush-atomico-base
pnpm add nfrush-atomico-base
yarn add nfrush-atomico-base
bun add nfrush-atomico-base
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2021-11-24 |
| First published | 2021-11-23 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 3 |
| Unpacked size | 205.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | nfrush |

## Links

- npm: https://www.npmjs.com/package/nfrush-atomico-base
- npm.io page: https://npm.io/package/nfrush-atomico-base

## Dependencies (3)

- [babel](https://npm.io/package/babel.md) ^6.23.0
- [atomico](https://npm.io/package/atomico.md) latest
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.16.0

## Recent versions

- 0.0.11 (latest) — 2021-11-24
- 0.0.10 — 2021-11-23
- 0.0.9 — 2021-11-23
- 0.0.8 — 2021-11-23
- 0.0.7 — 2021-11-23
- 0.0.6 — 2021-11-23
- 0.0.4 — 2021-11-23
- 0.0.3 — 2021-11-23
- 0.0.2 — 2021-11-23
- 0.0.1 — 2021-11-23
- 0.0.0 — 2021-11-23

## README

![Atomico](https://raw.githubusercontent.com/atomicojs/docs/master/.gitbook/assets/h4.svg)
![Atomico](https://raw.githubusercontent.com/atomicojs/docs/master/.gitbook/assets/h3.svg)

### Hi, I'm [@uppercod](https://twitter.com/uppercod), creator of Atomico and I want to thank you for starting with Atomico.

If you need help you can find it at:

[![twitter](https://raw.githubusercontent.com/atomicojs/docs/master/.gitbook/assets/twitter.svg)](https://twitter.com/atomicojs)
[![discord](https://raw.githubusercontent.com/atomicojs/docs/master/.gitbook/assets/discord.svg)](https://discord.gg/7z3rNhmkNE)
[![documentation](https://raw.githubusercontent.com/atomicojs/docs/master/.gitbook/assets/doc-1.svg)](https://atomico.gitbook.io/doc/)
[![discord](https://raw.githubusercontent.com/atomicojs/docs/master/.gitbook/assets/doc.svg)](https://webcomponents.dev/edit/collection/F7dm6YnMEDRtAl57RTXU/d6E4w07fsQbb0CelYQac)

Now what you have installed is a quick start kit based on Vite, which you can scale for your project, now to continue you must execute the following commands:

1. `npm install`
2. `npm start` : Initialize the development server
3. `npm build` : Optional, Generate a build of your project from the html file [index.html](index.html).

## Workspace

### Recommended structure

```bash
src
  |- my-component
  |  |- my-component.{js,jsx,ts,tsx}
  |  |- my-component.test.js
  |  |- my-component.css
  |  |- README.md
  |- components.js # import all components
```

### Add testing

The test environment is preconfigured for [@web/test-runner](https://modern-web.dev/docs/test-runner/overview/), you must complete the installation of the following devDependencies, installed the devDependencies you can execute the command `npm run test`:

```bash
npm install -D @web/test-runner @esm-bundle/chai vite-web-test-runner-plugin
```

#### Test example

```js
import { expect } from "@esm-bundle/chai";

describe("my test", () => {
  it("foo is bar", () => {
    expect("foo").to.equal("bar");
  });
});
```

> `@web/test-runner` supports asynchrony, coverage, [viewport and more](https://modern-web.dev/docs/test-runner/commands/).

### NPM export

Atomico owns the [@atomico/exports](https://atomico.gitbook.io/doc/atomico/atomico-exports) tool that simplifies the generation of builds, types and exports by distributing webcomponents in NPM, you must complete the installation of the following devDependencies, installed the devDependencies you can execute the command `npm run exports`:

```bash
npm install -D @atomico/exports
```

### Postcss

This configuration already depends on Postcss, you can more plugins through `package.json#postcss`, example:

```json
"postcss": {
  "plugins": {
    "postcss-import": {}
  }
}
```

> In case of build, Atomico will minify the CSS code.

### Github page

Add to `package.json#scripts.build`:

```bash
--outDir docs # modify the destination directory
--base my-repo # github page folder
```

---
_Source: https://npm.io/package/nfrush-atomico-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._