Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

@academysports/fusion-components

2.0.3 • Public • Published

Fusion Components

How to use

  • Make sure you are logged-in via npm login or have a .npmrc file with related permisssion to access our private repo with @academysports scope.

  • Install the fusion components via npm install @academy/fusion-components .

Developement

  • Clone the repository at (https://bitbucket.org/academysports/ui-atomic-components/)

  • Write your component logic inside components folder

  • npm start starts a component explorer based on style-guidist which can be used for local developement and reference

  • npm run generate provides a handy generator, so that you dont have to copy paste stuff :)

  • For local testing of atomic-components that are in progress do a npm link in the repo which will export the repo as a npm module to your local npm module folder.

  • Go to your target repo and npm link @academysports/fusion-components to enable a symlink between your consuming repo's node_modules and the atomic-component repository.

  • Once you have completed developement , pls make sure to export your component in the root index.js . Also add an addition in webpack.dist.config.js's entry option to enable your component to be built. This is a multi-part module , so it requires multiple entry points

  • Once dev is done - run npm run build to create the dist folder

  • Run npm pack to generate the tarball to get an idea of how the components are going to be present when you do a npm install

  • After adding and commiting your components to your branch and raise a PR.

Features

Uses prettier and eslint for linting . Uses emotionJS for styling Uses mocha,chai,enzyme,sinon + JSDOM for unit testing.

What is Atomic Design?

Atomic design is methodology for creating design systems. There are five distinct levels in atomic design:

  • Atoms
  • Molecules
  • Organisms
  • Templates
  • Pages

Atoms

Atoms are the basic building blocks of matter. Applied to web interfaces, atoms are our HTML tags, such as a form label, an input or a button. The atoms should be written without margins and positions , position-ing of these atoms should be done by a molecule or organism that uses the atom.

This entire repository drives the atomic components that is used across our ecommerce application . Each atom should be a self sufficient entity , in that it should be unit testable, styled via CSS in JS ,consumable and extendable via props.

Below items are not part of this repository , but hey some theoritcal knowledge :)

Molecules

Molecules are groups of atoms bonded together and are the smallest fundamental units of a compound. These molecules take on their own properties and serve as the backbone of our design systems.

For example, a form label, input or button aren’t too useful by themselves, but combine them together as a form and now they can actually do something together.

Organisms

Organisms are relatively complex UI components composed of groups of molecules and/or atoms and/or other organisms. These organisms form distinct sections of an interface.

Eg: Header,Footer, storelocator can use a combination of molecules and atoms to create a standalone module of a page.

Templates

Templates are page-level objects that place components into a layout and articulate the design’s underlying content structure.

We will not be creating any templates in our front-end code as the page layout is to a certain extent determined by AEM

Pages

Pages are specific instances of templates that show what a UI looks like with real representative content in place

That is about it here,. now go out there and build something :)

Notes
  • Futher Reading Atomic Design by Brad Frost : http://atomicdesign.bradfrost.com/table-of-contents/

  • All of our atoms will be moved to npm org repository of Academy npm

  • Guidelines for component developement - WIP

  • semver - TBD

  • host site created by style-guidist - TBD

Install

npm i @academysports/fusion-components

DownloadsWeekly Downloads

0

Version

2.0.3

License

MIT

Unpacked Size

268 kB

Total Files

22

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar