<commit_before># OS Explorer

[![Gitter](https://img.shields.io/gitter/room/openspending/chat.svg)](https://gitter.im/openspending/chat)
[![Build Status](https://travis-ci.org/openspending/os-explorer.svg?branch=master)](https://travis-ci.org/openspending/os-explorer)
[![Issues](https://img.shields.io/badge/issue-tracker-orange.svg)](https://github.com/openspending/openspending/issues)
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](http://docs.openspending.org/en/latest/developers/explorer/)

An app to explorer the OpenSpending database.

## Quick start


- get the code
`git clone https://github.com/openspending/os-explorer.git`

- install dependencies
`npm install`

- build the frontend assets
`npm run build`

- configure .env

For local development, add an `.env` file with the following settings:
```ini
# Required settings<commit_msg>Add dependent technologies to README<commit_after># OS Explorer

[![Gitter](https://img.shields.io/gitter/room/openspending/chat.svg)](https://gitter.im/openspending/chat)
[![Build Status](https://travis-ci.org/openspending/os-explorer.svg?branch=master)](https://travis-ci.org/openspending/os-explorer)
[![Issues](https://img.shields.io/badge/issue-tracker-orange.svg)](https://github.com/openspending/openspending/issues)
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](http://docs.openspending.org/en/latest/developers/explorer/)

The homepage and search frontend for Openspending, working in conjuction with [os-conductor](https://github.com/openspending/os-conductor).

- [NodeJS](https://nodejs.org/en/)
- [AngularJS](https://angularjs.org/)
- [ExpressJS](https://expressjs.com/)

## Quick start

- get the code
`git clone https://github.com/openspending/os-explorer.git`

- install dependencies
`npm install`

- build the frontend assets
`npm run build`

- configure .env

For local development, add an `.env` file with the following settings:
```ini
# Required settings
{'fraction_non_alphanumeric': 0.16905737704918034, 'fraction_numerical': 0.0, 'mean_word_length': 5.122257053291536, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 20, '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': '3559682', 'n_tokens_mistral': 667, 'n_tokens_neox': 639, 'n_words': 111}