Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bitbar/finka-js
Finka.js - Handy tool in nowadays JavaScript jungle
https://github.com/bitbar/finka-js
bitbar javascript javascript-library javascript-utility on-prem saas stdlib util utility utils vanilla-javascript vanilla-js
Last synced: 2 days ago
JSON representation
Finka.js - Handy tool in nowadays JavaScript jungle
- Host: GitHub
- URL: https://github.com/bitbar/finka-js
- Owner: bitbar
- License: mit
- Created: 2018-08-10T07:25:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T06:00:51.000Z (9 days ago)
- Last Synced: 2024-11-09T11:49:01.958Z (6 days ago)
- Topics: bitbar, javascript, javascript-library, javascript-utility, on-prem, saas, stdlib, util, utility, utils, vanilla-javascript, vanilla-js
- Language: JavaScript
- Homepage:
- Size: 3.76 MB
- Stars: 2
- Watchers: 8
- Forks: 7
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Finka.js
Handy tool in nowadays JavaScript jungle.
It's extending default JS classes like `Array` or `String` with new handy methods,
that probably sooner or later you are going to search for on Stack Overflow ;)
## What means _Finka_?
_Finka_ is Polish word and means a knife usually used by scouts. It's also abbreviation to _nóż fiński_ so _Finnish knife_.
According to _Wikipedia_ it's originally really Finnish knife called [Puukko](https://en.wikipedia.org/wiki/Puukko).
[Bitbar](https://bitbar.com/) is Finnish company responsible for [Bitbar Cloud](https://bitbar.com/testing/),
which hosts hundreds of Android and iOS devices, enabling users to create and test high quality mobile apps and games.
Main R&D team is in Wrocław, Poland.
## Getting Started
### Prerequisites
This package is using [UMD](https://github.com/umdjs/umd/blob/master/templates/returnExportsGlobal.js) pattern, so it means that you can use it:
* in Node.js project
* browser running project
* without AMD
* with AMD
### Usage
Install:
```sh
npm install @bitbar/finka
```
And then in you main JS file:
```js
const finka = require('@bitbar/finka');
finka();
```
### Documentation
[https://bitbar.github.io/finka-js/](https://bitbar.github.io/finka-js/)
## Contribution
### Checking code quality
```sh
npm run lint
```
### Running tests
```sh
npm run test
```
### Building
```sh
npm run build
```
### Updating documentation
```sh
npm run docs
```
## Authors
* **Marek Sierociński** - [marverix](https://github.com/marverix)
* **tpiechaczek** - [tpiechaczek](https://github.com/tpiechaczek)
* **Bartosz Trzos** - [Trzosoo](https://github.com/Trzosoo)
* **Alberto Luis Fernandez Reyes** - [alberto-f](https://github.com/alberto-f)
* **ToniaR** - [ToniaR](https://github.com/ToniaR)
* **Toni** - [ToniVaakanainen](https://github.com/ToniVaakanainen)
* **gfduszynski** - [gfduszynski](https://github.com/gfduszynski)
See also the list of [contributors](https://github.com/bitbar/finka-js/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details