Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ecomplus/application-sdk

Abstractions for apps authentication and methods to Store API with NodeJS and Firestore/SQLite
https://github.com/ecomplus/application-sdk

applications authentication-service ecommerce-apps ecomplus firestore integration-flow nodejs sqlite store-api

Last synced: 19 days ago
JSON representation

Abstractions for apps authentication and methods to Store API with NodeJS and Firestore/SQLite

Host: GitHub
URL: https://github.com/ecomplus/application-sdk
Owner: ecomplus
License: mit
Created: 2018-11-11T02:20:33.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-10-01T04:31:17.000Z (about 2 months ago)
Last Synced: 2024-10-11T20:19:52.606Z (about 1 month ago)
Topics: applications, authentication-service, ecommerce-apps, ecomplus, firestore, integration-flow, nodejs, sqlite, store-api
Language: JavaScript
Homepage:
Size: 1.18 MB
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # E-Com Plus Application SDK

[![CodeFactor](https://www.codefactor.io/repository/github/ecomplus/application-sdk/badge)](https://www.codefactor.io/repository/github/ecomplus/application-sdk) [![npm version](https://img.shields.io/npm/v/@ecomplus/application-sdk.svg)](https://www.npmjs.org/@ecomplus/application-sdk) [![npm version](https://img.shields.io/npm/v/@ecomplus/application-sdk/firestore.svg)](https://www.npmjs.com/package/@ecomplus/application-sdk/v/firestore) [![npm version](https://img.shields.io/npm/v/@ecomplus/application-sdk/sqlite.svg)](https://www.npmjs.com/package/@ecomplus/application-sdk/v/sqlite) [![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Abstractions for apps authentication and methods to [E-Com Plus Store API](https://developers.e-com.plus/docs/api/#/store/) with NodeJS and Firestore/SQLite.

## Getting started

Install pkg with `firestore` or `sqlite` tag:

```bash

npm i --save @ecomplus/application-sdk@firestore

# OR

npm i --save @ecomplus/application-sdk@sqlite

```

Or you may also install default version and respective database client (depending on your environment):

```bash

npm i --save @ecomplus/application-sdk --no-optional

```

```bash

npm i --save sqlite3@4

# OR

npm i --save firebase-admin@8

```

## Environment variables

Variable                    | Default        | Info

---                         | ---            | ---

`ECOM_AUTH_DB`              | `./db.sqlite3` | SQLite3 database pathname (if not using Firestore)

`ECOM_AUTH_UPDATE`          | `enabled`      | Set `disabled` to prevent `update-tokens` automatic service

`ECOM_AUTH_DEBUG`           |                | Set `true` to debug setup and background services

`ECOM_AUTH_SETUP_TIMEOUT`   | `enabled`      | `disabled` on Google (Firebase) Cloud Functions by default

`ECOM_AUTH_UPDATE_INTERVAL` | `enabled`      | `disabled` on Google (Firebase) Cloud Functions by default

## Documentation

> No methods reference (TODO)