https://github.com/uppercod/run-perf

Build performance tests with the help of webcomponents
https://github.com/uppercod/run-perf

Last synced: about 3 hours ago
JSON representation

Build performance tests with the help of webcomponents

• Host: GitHub
• URL: https://github.com/uppercod/run-perf
• Owner: UpperCod
• Created: 2020-05-02T22:26:12.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-05T05:53:09.000Z (over 4 years ago)
• Last Synced: 2024-10-31T08:24:08.927Z (6 days ago)
• Language: CSS
• Homepage: https://uppercod.github.io/run-perf/
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Getting started with Atomico

[Español](./lang/spanish.md) [English](./README.md)

This configuration allows a dynamic development based on the export from html files (If like [Parceljs](https://parceljs.org/)! 🤓), using the `npm start` scripts you can develop components that are displayed by the browser Thanks to a server with console-taught local livereload, by default it can be hosted on the `localhost:8000` port.

## Directory

```bash

/src

    /components # Directory for webcomponents

        /atomico-counter # Example of component with Atomico

            atomico-counter.js

            atomico-counter.css

            atomico-counter.md  # component documentation

    index.html # Html file to serve on the server

```

> files exported from html are stored processed in `/docs`(Friendly with github pages 😎), you can change this effect by modifying the`scripts` of `package.json`.

## Scripts

### npm start

Initialize a developing server for the files that are exported from the html files in the `src/*.html` directory.

### npm run build

Create the export bundle from the html files.

### npm run build:npm

Package for distribution in NPM all the components of the `src/components` directory, these are exported as separate files.

> remember to distribute in npm you must modify the **package.json**.

### npm run create:component

Create a component in the `src/components` directory [with the recommended structure](https://atomico.gitbook.io/doc/v/es/guias/guias-de-estilo) `Atomico`.

### npm run create:hook

Create a hook in the `src/hooks` directory with the [recommended structure](https://atomico.gitbook.io/doc/v/es/guias/guias-de-estilo) `Atomico`.