<commit_before># Scarab, a minimal web framework

Scarab is a thin wrapper around Express, providing on structure, configuration and database abstraction.
The structure is inspired by [Rails](http://rubyonrails.org/) and [Sails.js](http://sailsjs.org/), but with focus on keeping it simple. If the terms model, view, controller and route are new for you, please have a look at the documentation of Rails or Sails, as those do a better job on explaining them.

### Motivation behind Scarab
* use Express and existing libraries
* provide structure
* keep it simple and readable (~500 lines of code).


## Bootstrap the app

To start a server in the current directory:
```javascript
// index.js
var scarab = require('scarab');
module.exports = scarab(__dirname);
```


## Directory structure

By default Scarab looks for the following subdirectories:
* config
* init
* models
* controllers<commit_msg>Add installation to README<commit_after># Scarab, a minimal web framework

Scarab is a thin wrapper around Express, providing on structure, configuration and database abstraction.
The structure is inspired by [Rails](http://rubyonrails.org/) and [Sails.js](http://sailsjs.org/), but with focus on keeping it simple. If the terms model, view, controller and route are new for you, please have a look at the documentation of Rails or Sails, as those do a better job on explaining them.

### Motivation behind Scarab
* use Express and existing libraries
* provide structure
* keep it simple and readable (~500 lines of code).

## Installation
```
> npm install floridoo/scarab
```

## Bootstrap the app

To start a server in the current directory:
```javascript
// index.js
var scarab = require('scarab');
module.exports = scarab(__dirname);
```


## Directory structure

By default Scarab looks for the following subdirectories:
* config
* init
* models
* controllers
{'fraction_non_alphanumeric': 0.08480944712828771, 'fraction_numerical': 0.00322061191626409, 'mean_word_length': 4.735384615384615, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 0, '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': '1232390', 'n_tokens_mistral': 515, 'n_tokens_neox': 479, 'n_words': 242}