@dac-software/forms-pl - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2-PW-working-sending-form-release.1

package.json

 {
   "name": "@dac-software/forms-pl",
-  "version": "0.0.1",
+  "version": "0.0.2-PW-working-sending-form-release.1",
   "license": "UNLICENSED",
@@ -5,0 +5,0 @@ "main": "dist/forms-pl",

README.md

@@ -1,1 +0,106 @@
-TODO
+# Forms
+
+This library has forms integrated with SalesForce forms. It can be applied to qarson pl website.
+Library uses react, typescript, css written in SASS preprocessor.
+
+Developing bundler is webpack. 
+
+Build production build made as simple tsc compilation with asset files copies provided
+
+## Requirements
+
+- nodejs v10 +
+- npm v6.9.0 +
+
+## Installation:
+
+Installing dependencies
+```bash
+npm install
+```
+
+Build production library files
+```bash
+npm run build
+```
+
+\* Build task build two types of library entrypoints :
+* "web" - destined to web include (for example by script tag) with all depedencies built in (like react, redux and other third party libraries)
+* "ecma script module" - destined for further bundler processing, it is resolved through simply typescript compiling in package.json statement
+    ```bash
+    tsc -p tsconfig-prod.json && copyfiles "./lib/**/*.!(tsx|ts|d.ts|html)" "dist/esm" -u 1
+    ```
+
+##Development
+
+Running dev server in standalone mode
+```bash
+npm run start
+```
+
+Running dev mode through bundler in other project.
+Project should be linked by npm.
+
+```bash
+npm run build:dev
+```
+\* build dev emmits files into dist/esm without CSS / files extraction, it is determined by webpack condition on compilation mode
+
+Running tests
+```bash
+npm run test
+```
+
+####Codestyle
+
+We are in consonance with **standardx**.
+
+Validation codestyle:
+
+```bash
+npm run codestyle-check-typescript
+```
+
+Automatic fix:
+
+```bash
+npm run codestyle-typescript-fix
+```
+
+####CI (bitbucket pipelines)
+
+Checks codestyles and run tests
+
+##Compilation summary
+| | ```npm start``` - (standalone dev) | ```npm run build:dev``` (imported as esm in higher bundler) | ```npm run build``` (production build)
+|---|---|---|---|
+|key dist files|none|dist/esm/forms-pl.js|dist/esm/forms-pl.js, dist/forms-pl.js, dist/forms-pl.css
+|css extraction|no|css in js|esm: css in js, web: extracted
+|files extraction|no|yes|no (copied)
+##App configuration
+
+Forms PL react app **requires** simple configuration object in window `formConfig` property.
+
+Example :
+
+```javascript
+ var formConfig = {
+          locale: 'pl',
+          formApiSfUrl: 'Salesforce form api url',
+          formOid: 'salesforce unique environment ID',
+      }
+
+Object.defineProperty(window, 'formConfig', { value: formConfig })
+```
+
+## NPM publishing:
+
+1) Increase version in package.json 
+2) Npm login with proper username, password and email
+    ```bash
+    npm login
+    ```
+3) Npm publish (command will trigger prepare npm method which should build files to dist directory)
+    ```bash
+    npm publish --access=public
+    ```

No alert changes

Improved metrics

Total package byte prevSize

349135

increased by0.7%

Number of lines in readme file

107

increased by5250%

No dependency changes