# hidro

> Dead simple web prototyping framework for developers

Latest version **0.0.2** (published 2017-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install hidro
pnpm add hidro
yarn add hidro
bun add hidro
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-04-26 |
| First published | 2016-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sergio Uve |
| Maintainers | sergiouve |
| Keywords | prototyping |

## Links

- npm: https://www.npmjs.com/package/hidro
- Repository: https://github.com/sergiouve/hidro
- Homepage: https://github.com/sergiouve/hidro#readme
- Issues: https://github.com/sergiouve/hidro/issues
- npm.io page: https://npm.io/package/hidro

## Dependencies (7)

- [gulp](https://npm.io/package/gulp.md) ^3.9.1
- [jquery](https://npm.io/package/jquery.md) ^3.2.1
- [gulp-sass](https://npm.io/package/gulp-sass.md) ^3.1.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.8
- [gulp-shell](https://npm.io/package/gulp-shell.md) ^0.6.3
- [gulp-imagemin](https://npm.io/package/gulp-imagemin.md) ^3.2.0
- [gulp-autoprefixer](https://npm.io/package/gulp-autoprefixer.md) ^3.1.1

## Recent versions

- 0.0.2 (latest) — 2017-04-26
- 0.0.1 — 2016-07-07

## README

# hidro

*Dead simple web prototyping framework for developers*

- [Installation](#installation)
- [Usage](#usage)
  + [Startup](#startup)
  + [Structure](#structure)
  + [Workflow](#workflow)

#### What is it?
Hidro is a dead simple prototying/design tool for developers.
Use **HTML and CSS** to quickly create a styleguide, views and components on a fully navigable web.

#### What is it not?
Hidro is not supposed to be used to power a *real life* production webapp, it is designed to just prototype/design it.

<a name="installation"></a>
## Installation

### Using git
```bash
git clone https://github.com/sergiouve/hidro.git my_prototype
```

### Using yeoman
```bash
yo hidro
```

<a name="usage"></a>
## Usage

<a name="startup"></a>
### Startup

```bash
gulp
```

This will start compiling assets and boot up a server on **localhost:3000**

<a name="structure"></a>
### Structure

Hidro uses the following file structure
```
assets/
├── images/
├── scripts/
│   └── prototype.js
├── styles/
│   └── main.css
└── vendors/

helpers/
├── config.php
└── url.php

resources/

src/
├── images/
├── scss/
│   ├── common/
│   │   ├── _base.scss
│   │   ├── _helpers.scss
│   │   ├── _mixins.scss
│   │   ├── _typography.scss
│   │   └── _variables.scss
│   ├── components/
│   │   └── _example-component.scss
│   ├── pages/
│   │   ├── _styleguide.scss
│   │   └── _welcome.scss
│   └── main.scss
└── vendors/

views/
├── components/
├── layouts/
│   ├── footer.view.php
│   └── header.view.php
├── pages/
│   ├── styleguide.view.php
│   └── welcome.view.php
└── layout.view.php

gulpfile.js
index.php
package.json
README.md
```

<a name="workflow"></a>
### Workflow

1. Views

2. SCSS

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