# fed-starter

> Frontend developer website starter pack

Latest version **0.1.0** (published 2019-04-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install fed-starter
pnpm add fed-starter
yarn add fed-starter
bun add fed-starter
```

## 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.1.0 |
| Published | 2019-04-17 |
| First published | 2019-04-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 53.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Adam Szałapski |
| Maintainers | adam2661 |

## Links

- npm: https://www.npmjs.com/package/fed-starter
- Repository: https://github.com/adamszalapski/website-starter
- Homepage: https://github.com/adamszalapski/website-starter#readme
- Issues: https://github.com/adamszalapski/website-starter/issues
- npm.io page: https://npm.io/package/fed-starter

## Dependencies (3)

- [jquery](https://npm.io/package/jquery.md) ^3.3.1
- [slick-carousel](https://npm.io/package/slick-carousel.md) ^1.8.1
- [foundation-sites](https://npm.io/package/foundation-sites.md) ^6.4.4-rc1

## Recent versions

- 0.1.0 (latest) — 2019-04-17

## README

# Git clone
I would suggest clone FED gulp starter into `_fed` folder localized into project root.

# Installation

**Ruby**
To install ruby go to official [website](http://rubyinstaller.org/)

**1. sass**

```sh
$ gem install sass
```

**Node.js**
To install node.js go to official [website](http://nodejs.org/)

**1. gulp**

```sh
$ _fed/npm install --global gulp
```

**2. install node and bower dependencies**

```sh
$ _fed/npm install
```
    
### Run app

**Start file watchers**

```sh
$ _fed/gulp or _fed/npm start
```
    
### How should I use this _fed files structure properly?
**The only files you will edit** are config.js and inside `src` folder. There are sub-folders like:
  - `css` has `main.scss` file which gonna be minify and optimized for all supported browsers
  - `js` all scripts will be compile, minify and concat
  - `images` all `image files` in this folder gonna be compressed and optimized

Compiled files will be genarated into `./preview` folder. You can always change destination folder variable **outputPath** in `config.js`

### Feedback
If you have any problems or improvements suggestion feel free to email me szalapski.adam@gmail.com

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