<commit_before># Stripes Core

This is a single-page web application that provides a platform for React components from configured modules according to their "type". (At the moment, the only "type" is "fullpage" and from metadata we glean which routes to display which components on and which of those need menu entries.) 


## Documentation roadmap

* Quick start guide: read on below
* [Overview of the Stripes architecture](doc/overview.md)
* [Running Stripes from git checkouts](doc/building-from-git-checkouts.md)
* [Testing the Okapi Console and circulation module](../okapi-console/testing-the-circulation-module.md)
* [The stripes-connect API](../stripes-connect/api.md)
* [A component example: the **PatronEdit** component](doc/component-example.md)
* [A component hierarchy example: the "Patrons" module](doc/component-hierarchy.md)


## Quick start

To run Stripes, you'll need to have [Node.js](https://nodejs.org/) 6.x installed.

### Very quick

```
npm config set @folio:registry https://repository.folio.org/repository/npm-folio/
npm install
npm config set @folio-sample-modules:registry https://repository.folio.org/repository/npm-folio/
npm install @folio-sample-modules/trivial
```

### Some details
 
Add the FOLIO NPM registry to your local NPM configuration:

`npm config set @folio:registry https://repository.folio.org/repository/npm-folio/`

Retrieve the necessary dependencies:

`npm install`

At this point you have what you need to run the system. Edit `webpack.config.cli.js` to indicate which modules you want to include and the URL to the back end. Run `npm start` to bring up a development server at http://localhost:3000/ or `npm run build` to output a set of files which can then be deployed to a web server.

### Demos

We have some sample modules to play with in the `@npm-sample-modules` scope on our registry. Run this to let it know where to look:

`npm config set @folio-sample-modules:registry https://repository.folio.org/repository/npm-folio/`

#### trivial

The default configuration references a module, "trivial", which demonstrates a simple use of "stripes-connect". You can install it via npm:

`npm install @folio-sample-modules/trivial`

#### trivial-okapi<commit_msg>add node.js version check, add cd stripes-core<commit_after># Stripes Core

This is a single-page web application that provides a platform for React components from configured modules according to their "type". (At the moment, the only "type" is "fullpage" and from metadata we glean which routes to display which components on and which of those need menu entries.) 


## Documentation roadmap

* Quick start guide: read on below
* [Overview of the Stripes architecture](doc/overview.md)
* [Running Stripes from git checkouts](doc/building-from-git-checkouts.md)
* [Testing the Okapi Console and circulation module](../okapi-console/testing-the-circulation-module.md)
* [The stripes-connect API](../stripes-connect/api.md)
* [A component example: the **PatronEdit** component](doc/component-example.md)
* [A component hierarchy example: the "Patrons" module](doc/component-hierarchy.md)


## Quick start

To run Stripes, you'll need to have [Node.js](https://nodejs.org/) 6.x installed.
```
node --version
v6.8.0
```

### Very quick

```
cd stripes-core
npm config set @folio:registry https://repository.folio.org/repository/npm-folio/
npm install
npm config set @folio-sample-modules:registry https://repository.folio.org/repository/npm-folio/
npm install @folio-sample-modules/trivial
```

### Some details

Go into the stripes-core directory within this stripes-experiments module:

`cd stripes-core`

Add the FOLIO NPM registry to your local NPM configuration:

`npm config set @folio:registry https://repository.folio.org/repository/npm-folio/`

Retrieve the necessary dependencies:

`npm install`

At this point you have what you need to run the system. Edit `webpack.config.cli.js` to indicate which modules you want to include and the URL to the back end. Run `npm start` to bring up a development server at http://localhost:3000/ or `npm run build` to output a set of files which can then be deployed to a web server.

### Demos

We have some sample modules to play with in the `@npm-sample-modules` scope on our registry. Run this to let it know where to look:

`npm config set @folio-sample-modules:registry https://repository.folio.org/repository/npm-folio/`

#### trivial

The default configuration references a module, "trivial", which demonstrates a simple use of "stripes-connect". You can install it via npm:

`npm install @folio-sample-modules/trivial`

#### trivial-okapi
{'fraction_non_alphanumeric': 0.10240833152527663, 'fraction_numerical': 0.0028205684530266868, 'mean_word_length': 4.621951219512195, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, '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': '6237596', 'n_tokens_mistral': 1341, 'n_tokens_neox': 1256, 'n_words': 535}