# fidj

> api.fidj.ovh js framework

Latest version **15.0.4** (published 2024-11-06) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install fidj
pnpm add fidj
yarn add fidj
bun add fidj
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 15.0.4 |
| Published | 2024-11-06 |
| First published | 2018-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 841.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | fidj |
| Maintainers | mlefree |
| Keywords | fidj, ovh, mobile, angular, ng, ionic, integration |

## Links

- npm: https://www.npmjs.com/package/fidj
- Repository: https://github.com/ofidj/fidj
- Homepage: https://github.com/ofidj/fidj#readme
- Issues: https://github.com/ofidj/fidj/issues
- npm.io page: https://npm.io/package/fidj

## Dependencies (5)

- [atob](https://npm.io/package/atob.md) ^2.1.2
- [btoa](https://npm.io/package/btoa.md) ^1.2.1
- [axios](https://npm.io/package/axios.md) ^1.7.7
- [url-join](https://npm.io/package/url-join.md) ^4.0.1
- [localstorage-polyfill](https://npm.io/package/localstorage-polyfill.md) ^1.0.1

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 15.0.4 (latest) — 2024-11-06
- 15.0.3 — 2024-11-06
- 15.0.1 — 2024-11-04
- 14.2.10 — 2024-01-16
- 3.3.6 — 2021-05-31
- 3.3.5 — 2021-05-29
- 3.3.4 — 2021-05-21
- 3.3.3 — 2021-05-19
- 3.3.2 — 2021-05-18
- 3.3.1 — 2021-05-12
- 3.3.0 — 2021-05-12
- 2.1.44 — 2021-03-08
- 2.1.43 — 2020-11-25
- 2.1.42 — 2020-11-25
- 2.1.41 — 2020-09-06
- … 31 more at https://npm.io/package/fidj/versions

## README

[![Build Status](https://api.travis-ci.com/ofidj/fidj.svg)](https://app.travis-ci.com/github/ofidj/fidj) 
[![NPM version](https://badge.fury.io/js/fidj.svg)](https://www.npmjs.com/package/fidj) 
[![Package Quality](http://npm.packagequality.com/shield/fidj.svg)](http://packagequality.com/#?package=fidj)

> [Install](https://github.com/ofidj/fidj#1-youre-an-app-builder) | [APIs](https://ofidj.github.io/fidj) | [Support](https://github.com/ofidj/fidj#develop)  | [In progress](https://github.com/ofidj/fidj#in-progress) | [Thanks!](https://github.com/ofidj/fidj#thanks)

# 1) You're an app builder
Thank you for building great app. 
Fidj.ovh will support you to manager auth, session storage.

### The easiest way

From scratch, with *yeoman* like described here : https://github.com/ofidj/fidj/wiki/How-build-a-freemium-angular-mobile-application-in-10-minutes
```bash
yo fidj
``` 

### The normal way

Install with NPM :
```bash
npm install fidj --save
```

Look at APIs and integration patterns described in [https://ofidj.github.io/fidj/](https://ofidj.github.io/fidj/)
- with [Angular](https://ofidj.github.io/fidj/classes/fidjservice.html)
- with pure js

In brief :
```js
// init your app
await fidjService.init('Your FidjAppId from https://fidj.ovh');

// login (auto register) your user
await fidjService.login('login', 'password');

// synchronise your session data
await fidjService.sync();

// put your data into session, 
// it will be available everywhere but also offline
await fidjService.put({data : 'my session'});

//... sync, get data and so on

// logout if needed
await fidjService.logout();

```

# 2) You're a fidj dev
Thank you for your support !

Fidj.ovh is an Open Source project - we need you to provide great tools to great apps.

## Develop

Fork the project
```bash
git clone https://github.com/ofidj/fidj.git
cd fidj
npm install
```
And make pull request ...

### Testing

With npm :
```bash
$ npm test
```

With a OpenAPI (TODO) :  
https://app.swaggerhub.com/api/mlefree/fidj-io_rest_api/

## Release notes

In [Release notes](./RELEASE.md).

# Thanks

[@fidj](https://fidj.ovh) @mat_cloud

---
_Source: https://npm.io/package/fidj · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._