DEITY Falcon is a platform agnostic PWA, stand-alone but modular library to be used with any e-commerce platform.
- Apollo
- NodeJS
- Razzle
- GraphQL
- React
- Koa
- Jest (testing)
Any contributions, small or big, are very welcome! Please take a look at our Contributor guidelines and Code of Conduct
Join the official chat channel
NodeJS (8.x +) https://nodejs.org
Yarn (Optional, but recommended) https://yarnpkg.com
Yarn can be installed via npm install -g yarn
or https://yarnpkg.com/lang/en/docs/install
Use the project generator:
Out of the box, it connects to a public back-end service (Magento & WordPress), so you can start developing right away.
Install falcon-magento2-module in Magento 2
Install falcon-wordpress-module in WordPress
Coming soon
Inside server/config
change apis.config
to your instance's credentials
Please check out https://github.com/deity-io/falcon/tree/master/packages/falcon-ui
Coming soon
Yarn and Node are required for core development.
cd package-name
yarn add dependency-name
There are 2 main scripts available - test
and test:coverage
:
test
in the root package.json file - triggerstest:coverage
script in every available package (it is used by the CI system mainly)test
in the module's package.json - runs Jest testing in "watch" mode (re-runs tests on every code change)test:coverage
in the module's package.json runs Jest testing with enabled Coverage option
cd package-name
yarn test
yarn test:coverage
- jest for all packages
- changelog generation? - https://github.com/lerna/lerna-changelog
- learna publish packages to npm script?