1.0.8 • Published 6 years ago

@gaspard-bruno/etudes-ecommerce-core v1.0.8

Weekly downloads
10
License
UNLICENSED
Repository
github
Last release
6 years ago

E-commerce core

Core component library for e-commerce apps.

Includes support for:

  • Chat

Integrate into your project

Note: Because the core library could live in a private registry it would be advisable to generate an OAuth token within npm.

Add a dependency in your package.json:

"dependencies": {
    "@gaspard-bruno/etudes-ecommerce-core": "^1.0.0",
    ...

The library will be installed the next time you npm install.

Specification

Formal specification in the form of Jasmine test cases can be found in the spec folder.

Frameworks

  • Redux

Libraries

  • Fetch
  • Redux-Thunk
  • Reselect

Components

  • Reducers
  • Action creators
  • Memoized selectors
  • API Client
  • Service adapters for REST, WebSocket

Develop the library

Use npm scripts to build the library:

npm run build

To watch for changes, run the linter, transpile and run the unit tests you can run:

npm start

Develop side by side with your client project

Use npm link to have a working development copy of the library within your project:

npm uninstall ecommerce-core
cd ../core
npm link
cd ../app
npm link ecommerce-core

To revert:

npm unlink ecommerce-core
cd ../core
npm unlink
npm install ecommerce-core

Docker

You can use docker to test and develop this library

Build image for the first time

docker build -t ecommerce-core --build-arg NPM_TOKEN= .

Create a container for the first time

docker run --rm -e NPM_TOKEN= -v $PWD:/usr/src/app -v /usr/src/app/node_modules ecommerce-core

To clean the project:

docker run --rm -v $PWD:/usr/src/app -v /usr/src/app/node_modules ecommerce-core run clean