<commit_before># Generator for Frontend Projects

[![Join the chat at https://gitter.im/FuelFrontend/generator-smacss](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/FuelFrontend/generator-smacss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Code Climate](https://codeclimate.com/github/FuelFrontend/generator-smacss/badges/gpa.svg)](https://codeclimate.com/github/FuelFrontend/generator-smacss)

Perfectionist generator that scaffolds out different types of Front-end application [Work In Progress]

# Features

- **Different Projects; One Generator** - Create your type of project in fairly simple steps
- **Highly Maintainable** - Uses [SMACSS](https://smacss.com/) approach (BEM, OOCSS, ITCSS to be followed soon)
- **Readymade** — Directory structure, Naming convention, Linking your app done right.
- **Speedy Workflow** - CSS Preprocessor (Sass), Partials, Browser Sync, Live reload.
- **Performance Matters**  - Minify HTML, CSS, & JS. Optimize Images.
- **Quick Commands** - Generate Build, Clean up, Zip project and more.

# App Types

- **Simple Web App** — Sometimes you just need a gulp server(localhost), scss compiler & browser-sync(live reload). Well that's exactly what this app is for.
- **Full Pack Web App** - Thinking of creating a solid frontend base with proper structure, well optimization; choose this applicaton type which comes with power features.
- **Angular App** - Work In Progress

# Getting Started

**Installation**

- You need to have [NodeJS](http://nodejs.org/) & [Yeoman](http://yeoman.io/) `npm install -g yo` installed.
- Install the generator `npm install --global generator-smacss`

**Ready to create your project**

- Run `yo smacss` to scaffold your webapp
- Answer simple questions in terminal
- Generator will automatically try to install dependencies in your project folder.
- You got your installation successfull, run the server following the instruction in next section.
- If you don't have admin rights it may fail; In such cases
  	- a) cd to your project folder
  	- b) Run `sudo bower install & npm install` followed by your machine password

**Run your project**

At this stage your project is setup and dependencies are installed, It's showtime!

- Run `gulp` to run the server, You are all done.

# Docs

To be updated soon... stay tuned
<commit_msg>#14 directory structure for simple web and full pack updated<commit_after># Generator for Frontend Projects

[![Join the chat at https://gitter.im/FuelFrontend/generator-smacss](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/FuelFrontend/generator-smacss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Code Climate](https://codeclimate.com/github/FuelFrontend/generator-smacss/badges/gpa.svg)](https://codeclimate.com/github/FuelFrontend/generator-smacss)

[Work In Progress] Perfectionist generator that scaffolds out different types of Front-end application

# Features

- **Different Projects; One Generator** - Create your type of project in fairly simple steps
- **Highly Maintainable** - Uses [SMACSS](https://smacss.com/) approach (BEM, OOCSS, ITCSS to be followed soon)
- **Readymade** — Directory structure, Naming convention, Linking your app done right.
- **Speedy Workflow** - CSS Preprocessor (Sass), Partials, Browser Sync, Live reload.
- **Performance Matters**  - Minify HTML, CSS, & JS. Optimize Images.
- **Quick Commands** - Generate Build, Clean up, Zip project and more.

# App Types

- **Simple Web App** — Sometimes you just need a gulp server(localhost), scss compiler & browser-sync(live reload). Well that's exactly what this app is for.
- **Full Pack Web App** - Thinking of creating a solid frontend base with proper structure, well optimization; choose this applicaton type which comes with power features.
- **Angular App** - Work In Progress

# Directory Structure

Your directory structure will look like this

**Simple Web App**

``````````
├── app
│   ├── images
│   ├── fonts
│   ├── js
│   │   └── lib
│   │   │   └── third-party-files.js
│   │   └── application.js
│   ├── css
│   │   └── master.css
│   ├── scss
│   │   └── modules
│   │   │   └── module-name.scss
│   │   └── pages
│   │   │   └── page-landing.scss
│   │   └── base.scss
│   │   └── layout.css
│   │   └── mixins.css
│   │   └── master.css
│   │   └── reset.css
│   │   └── variables.css
│   └── index.html
├── node_modules
├── .bowerrc
├── .gitignore
├── bower.json
├── gulpfile.js
└── package.json
``````````

**Full Pack Web App**

``````````
├── app
│   ├── bower_components
│   │   ├── jquery
│   │   └── modernizr
│   ├── images
│   ├── js
│   │   └── lib
│   │   │   └── third-party-files.js
│   │   └── application.js
│   ├── css
│   │   └── master.css
│   ├── partials
│   │   └── header.html
│   │   └── footer.html
│   ├── scss
│   │   └── modules
│   │   │   └── module-name.scss
│   │   └── pages
│   │   │   └── page-landing.scss
│   │   └── base.scss
│   │   └── layout.css
│   │   └── mixins.css
│   │   └── reset.css
│   │   └── variables.css
│   └── index.html
├── build
│   └── build-files
├── zip
│   └── compressed-files
├── node_modules
├── .bowerrc
├── .gitignore
├── bower.json
├── gulpfile.js
└── package.json
``````````

**Angular App**

_WIP_


# Getting Started

**Installation**

You need to have [NodeJS](http://nodejs.org/) & [Yeoman](http://yeoman.io/) installed on your machine
```````
npm install -g yo
````````

Install smacss generator
```````
npm install --global generator-smacss
```````

**Creating project**

- Run `yo smacss`
- Answer simple questions in terminal
- Generator will automatically try to install dependencies in your project folder.

- You got your installation successfull 'You are lucky', run the server following the instruction in next section.
- In case you got any error you may not have admin rights
  	- a) cd to your project folder
  	- b) Run `sudo bower install & npm install` followed by your machine password in Mac/Linux environment; Windows user try running as administrator

**Run your project**

At this stage your project is setup and dependencies are installed, It's showtime!

- Run `gulp` to run the server, and you are good to start your development.

# Docs

To be updated soon... stay tuned

{'fraction_non_alphanumeric': 0.14185527574115397, 'fraction_numerical': 0.000956327701625757, 'mean_word_length': 3.7501892505677517, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5718727', 'n_tokens_mistral': 2059, 'n_tokens_neox': 2123, 'n_words': 789}