<commit_before># WikiPoetry

> Pithy project description

## Team

  - __Product Owner__: <NAME>
  - __Scrum Master__: <NAME>
  - __Development Team Members__: <NAME>, <NAME>

## Table of Contents

1. [Usage](#Usage)
1. [Requirements](#requirements)
1. [Development](#development)
    1. [Installing Dependencies](#installing-dependencies)
    1. [Tasks](#tasks)
1. [Team](#team)
1. [Contributing](#contributing)

## Usage

> Some usage instructions

## Requirements

- Node
- Express
- Flux
- React
- MongoDB

## Development

### Installing Dependencies

From within the root directory:

```sh
sudo npm install -g bower
npm install
bower install
```

### Roadmap

View the project roadmap [here](LINK_TO_PROJECT_ISSUES)


## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.<commit_msg>(docs) Updates readme with product description and usage<commit_after># WikiPoetry

> With over 5 million poems, WikiPoetry is your number one source of computer-generated poetry.


## Team

  - __Product Owner__: <NAME>
  - __Scrum Master__: <NAME>
  - __Development Team Members__: <NAME>, <NAME>

## Table of Contents

1. [Usage](#Usage)
1. [Requirements](#requirements)
1. [Development](#development)
    1. [Installing Dependencies](#installing-dependencies)
    1. [Tasks](#tasks)
1. [Team](#team)
1. [Contributing](#contributing)

## Usage

> WikiPoetry was designed to be familiar to users of WikiPedia. From the home page, click on a link to go down the WikiPoetry rabbit hole, or use the search feature to create custom poetry on your desired topic.

On each page, you can regenerate the poetry or select a poet from the navigation menu to re-render the poems in a different style. In true wiki fashion, users can also edit and save poems. These poems will become available under the 'User' style for any visitor to see.

## Requirements

- Node
- Express
- Flux
- React
- MongoDB

## Development

### Installing Dependencies

From within the root directory:

```sh
sudo npm install -g bower
npm install
bower install
```
### Running

From within the root directory:

```sh
gulp
```

If for some reason the gulp fails, the JavaScript and CSS can be compiled individually with 'gulp JS' and 'gulp CSS'. Then run a server with 'node server/server.js'.


### Roadmap

View the project roadmap [here](LINK_TO_PROJECT_ISSUES)


## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
{'fraction_non_alphanumeric': 0.10262725779967159, 'fraction_numerical': 0.006157635467980296, 'mean_word_length': 4.427616926503341, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6900760', 'n_tokens_mistral': 796, 'n_tokens_neox': 722, 'n_words': 287}