rekapi - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #go #android #rust #deep-learning #macos #nodejs #awesome #kubernetes #vue #awesome-list #openai

rekapi

(★ 659)

A keyframe animation library for JavaScript

File Explorer

Download Latest Version (.zip)

- - ci.yml
  - release.yml
- - canvas.js
  - dom.js
- actor.js
- keyframe-property.js
- main.js
- rekapi.js
- utils.js
- actor.js
- canvas.js
- dom.js
- get-css.js
- index.html
- index.js
- keyframe-property.js
- rekapi.js
- setup.js
- test-utils.js
- utils.js
- dom-rendering-in-depth.json
- dom-rendering-in-depth.md
- getting-started.json
- getting-started.md
- keyframes-in-depth.json
- keyframes-in-depth.md
- multiple-renderers.json
- multiple-renderers.md
.gitignore
.jsdoc
.jshintrc
.npmrc
CONTRIBUTING.md
index.md
jsconfig.json
LICENSE-MIT
package-lock.json
package.json
README.md
vite.config.mjs

# Installation Guide

1. Get the code

git clone https://github.com/jeremyckahn/rekapi

Downloads the entire project code from GitHub to your computer.

cd rekapi

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install --save rekapi

Downloads and installs the libraries listed in package.json.

npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

npm test

Type this command into your terminal and run it.

npm run doc

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rekapi - Keyframes for JavaScript

Rekapi is a keyframe animation library for JavaScript.  It gives you an API
for:

* Defining keyframe-based animations
* Controlling animation playback

Rekapi is renderer-agnostic.  At its core, Rekapi does not perform any
rendering.  However, it does expose an API for defining renderers, and comes
bundled with renderers for the HTML DOM and HTML5 2D `<canvas>`.

## Browser compatibility

Rekapi officially supports Evergreen browsers.

## Installation

```
npm install --save rekapi
```

## Developing Rekapi

First, install the dependencies via npm like so:

```
npm install
```

Once those are installed, you can generate `dist/rekapi.js` with:

```
npm run build
```

To run the tests in CLI:

```
npm test
```

To generate the documentation (`dist/doc`):

```
npm run doc
```

To generate, live-update, and view the documentation in your browser:

```
npm run doc:live
```

To start a development server:

```
npm start
```

Once that's running, you can run the tests at http://localhost:9010/test/ and
view the documentation at http://localhost:9010/dist/doc/.

## Loading Rekapi

Rekapi exposes a UMD module, so you can load it however you like:

```javascript
// ES6
import { Rekapi, Actor } from 'rekapi';
```

Or:

```javascript
// AMD
define(['rekapi'], rekapi => { });
```

Or even:

```javascript
// CommonJS
const rekapi = require('rekapi');
```

## Contributors

Take a peek at the [Network](https://github.com/jeremyckahn/rekapi/network)
page to see all of the Rekapi contributors.

## License

Rekapi is distributed under the [MIT
license](http://opensource.org/licenses/MIT).  You are encouraged to use and
modify the code to suit your needs, as well as redistribute it.