Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dhowe/RiTaJSv1

RiTa: the generative language toolkit (in JS)
https://github.com/dhowe/RiTaJSv1

Last synced: 3 days ago
JSON representation

RiTa: the generative language toolkit (in JS)

Host: GitHub
URL: https://github.com/dhowe/RiTaJSv1
Owner: dhowe
License: gpl-3.0
Created: 2015-09-18T09:45:01.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2022-12-02T18:37:44.000Z (almost 2 years ago)
Last Synced: 2024-11-06T01:35:27.859Z (8 days ago)
Language: JavaScript
Homepage:
Size: 7.57 MB
Stars: 268
Watchers: 18
Forks: 43
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build Status](https://travis-ci.org/dhowe/RiTaJS.svg?branch=master)](https://travis-ci.org/dhowe/RiTaJS)   [![CDNJS](https://img.shields.io/cdnjs/v/rita.svg)](https://cdnjs.com/libraries/rita/) [![Gitter](https://badges.gitter.im/dhowe/rita.svg)](https://gitter.im/dhowe/rita) 

### RiTa.js: a generative language toolkit for JavaScript



#### [The RiTa website](http://rednoise.org/rita)

RiTa.js is designed to an easy-to-use toolkit for experiments in natural language and generative literature, based on the [original RiTa](http://rednoise.org/rita) library for Processing/Java. RiTa.js works alone or with p5.js or node/npm, or in the browser.  All RiTa and RiTa.js tools are free/libre/open-source via the [GPL](http://www.gnu.org/licenses/gpl.txt).

#### About the project

--------

* Author:           [Daniel C. Howe](https://rednoise.org/daniel)

* Web Site:         https://rednoise.org/rita

* Reference:        http://www.rednoise.org/rita/reference/

* License:          GPL (see included [LICENSE](https://github.com/dhowe/RiTaJS/blob/master/LICENSE) file)

* Github Repo:      https://github.com/dhowe/RiTaJS/

* Issues:      https://github.com/dhowe/RiTa/issues

* FAQ: https://github.com/dhowe/RiTa/wiki

* Related:          [RiTa](https://github.com/dhowe/RiTa) (Java)

 

#### A simple sketch

--------

Create a new file on your desktop called 'test.html' and download the latest rita.js from [here](http://rednoise.org/rita/download/rita.min.js), add the following lines, save and drag it into a browser:

```html

  

  

  

    window.onload = function() {

      let words = RiTa.tokenize("The elephant took a bite!");

      $('#content').text(words);

    };

  

  


```

#### With [node.js](http://nodejs.org/) and [npm](https://www.npmjs.com/)

--------

To install: `$ npm install rita`

```javascript

let rita = require('rita');

let rs = rita.RiString("The elephant took a bite!");

console.log(rs.features());

```

#### With [p5.js](http://p5js.org/)

--------

Create a new file on your desktop called 'test.html' and download the latest rita.js from [here](http://rednoise.org/rita/download/rita.min.js), add the following lines, save and drag it into a browser:

```html

  

  

  

  function setup() {

    createCanvas(200,200);

    background(50);

    textSize(20);

    noStroke();

    let words = RiTa.tokenize("The elephant took a bite!")

    for (let i=0; i < words.length; i++) {

        text(words[i], 50, 50 + i*20);

    }

  }

  

```

#### With [browserify](http://browserify.org/) and [npm](https://www.npmjs.com/)

--------

Install [browserify](https://www.npmjs.com/package/browserify) (if you haven't already)

```

$ sudo npm install -g browserify

```

Create a file called 'main.js' with the following code:

```java

require('rita');

let rs = RiString("The elephant took a bite!");

console.log(rs.features());

```

Now install RiTa

```

$ npm install rita

```

Now use browserify to pack all the required modules into bundle.js

```

$ browserify main.js -o bundle.js

```

Create create a file called 'test.html' with a single script tag as below, then open it in a web browser and check the output in the 'Web Console'

```html

```

#### With [processing.js](http://processingjs.org)

--------

Create a new file on your desktop called 'test.html' and download the latest rita.js from [here](http://rednoise.org/rita/download/rita.min.js), add the following lines, save and drag it into a browser:

```html

  

  

  

    void setup() {

      size(200,200);

      background(50);

      textSize(20);

      noStroke();

      String words = RiTa.tokenize("The elephant took a bite!");

      for (int i=0; i < words.length; i++) {

          text(words[i], 50, 50 + i*20);

      }

    }

  

   

```

#### Can I contribute?

--------

Please! We are looking for more coders to help out... Just press *Fork* at the top of this github page and get started, or follow the instructions below...

#### Development Setup

--------

1. Download and install [git](https://www.git-scm.com/), [npm](https://www.npmjs.org/), and [gulp](). If you have them already, move on to step #2.

    a. You can find a version of __git__ for your OS [here](https://www.git-scm.com/)  

    b. The easiest way to install __npm__ is to install [node.js](http://nodejs.org/)  

    c. You can install __gulp__ via npm as follows:

    ```bash

    $ npm install -g gulp

    ```

  

2. [Fork and clone](https://help.github.com/articles/fork-a-repo) this library.

    a. First, login to github and fork the project  

    b. Then, from a terminal/shell:

    ```bash

    $ git clone https://github.com/dhowe/RiTaJS.git

    ```

3. Now navigate into the project folder and install dependencies via npm.

    ```bash

    $  cd RiTaJS && npm install

    ```

4. To create the library from src, use gulp.

    ```bash

    $ gulp build

    ```

5. Run the tests with gulp.

    ```bash

    $ gulp test

    ```

6. Work on an existing [issue](https://github.com/dhowe/RiTa/issues?q=is%3Aopen+is%3Aissue+label%3ARiTaJS), then [submit a pull request...](https://help.github.com/articles/creating-a-pull-request)