Merge pull request #156 from LieutenantRoger/npm-package-and-cicd

make the navigation module npm packagable

Author: sushilshinde

.circleci/config.yml

@@ -0,0 +1,48 @@
+defaults: &defaults
+  docker:
+    - image: circleci/node:8.11.2
+
+version: 2
+jobs:
+  test:
+    <<: *defaults
+    steps:
+      - checkout
+      - restore_cache:
+          key: node-modules-{{ checksum "package-lock.json" }}
+      - run: npm install
+      - save_cache:
+          key: node-modules-{{ checksum "package-lock.json" }}
+          paths:
+            - node_modules
+      - run: npm test
+      - run: npm run build
+      - persist_to_workspace:
+          root: .
+          paths:
+            - dist
+  release:
+    <<: *defaults
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+      - run: npm publish
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - test:
+          filters:
+            tags:
+              only: /.*/
+      - release:
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /v[0-9]+(\.[0-9]+)*(-[0-9]+)?/
+          requires:
+            - test

README.md

@@ -1,25 +1,14 @@
-# Topcoder Navigation React
+# Topcoder Navigation React Component
 
+![Dev Build Status](https://img.shields.io/circleci/project/github/topcoder-platform/navigation-component/develop.svg?label=develop)
+![Master Build Status](https://img.shields.io/circleci/project/github/topcoder-platform/navigation-component/master.svg?label=master)
+![Latest NPM Release](https://img.shields.io/npm/v/navigation-component.svg)
+![NPM Downloads](https://img.shields.io/npm/dm/navigation-component.svg)
 
-### Build the components
-
-Enter `navigation-component` and run:
-
-- `npm install`
-- `npm run build`
-
-Due to this repo is not npm package, so keep `dist` folder for other project use it
-
-
-## Getting Started
-
-### Install
-
-```
-npm install [email protected]:username/navigation-component.git#develop --save
-```
+The [Topcoder](https://www.topcoder.com) header navigation component.
 
 ### Usage
+
 - Example
 ```
 import { TopNav } from 'navigation-component'
@@ -28,13 +17,14 @@ import { TopNav } from 'navigation-component'
 ### Development
 
 ```shell
-Install dependencies
+# Install dependencies
 $ npm install
 
 # Run build
 $ npm run build
 
-#Go to other project which depends on the navigation-component, config its package.json so that the 'navigation-component' points to the local folder path of navigation-component:
+# Go to other project which depends on the navigation-component, config its package.json so 
+# that the 'navigation-component' points to the local folder path of navigation-component:
 
 # "dependencies": {
 #  "navigation-component": "<local-path-to-navigation-component>",
@@ -44,3 +34,6 @@ $ npm run build
 # If you faced React Hook errors. Please remove 'node_modules', 'src' folder when you try it
 
 ```
+
+### License
+UNLICENSED &mdash; for internal Topcoder projects.

package.json

@@ -1,8 +1,26 @@
 {
-  "name": "navigation-component",
-  "version": "1.0.0",
-  "description": "",
+  "bugs": {
+    "url": "https://github.com/topcoder-platform/navigation-component/issues"
+  },
+  "description": "Topcoder Navigation Component",
+  "engines": {
+    "node": "~8.11.2",
+    "npm": "~5.6.0"
+  },
+  "homepage": "https://github.com/topcoder-platform/navigation-component#readme",
+  "keywords": [
+    "Topcoder",
+    "React",
+    "Component",
+    "Navigation"
+  ],
+  "license": "UNLICENSED",
   "main": "index.js",
+  "name": "navigation-component",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/topcoder-platform/navigation-component.git"
+  },
   "scripts": {
     "lint": "eslint src/",
     "lint:fix": "eslint --fix src/",
@@ -11,6 +29,18 @@
     "build:prod": "./node_modules/.bin/webpack --env=production --progress --profile --colors --display-optimization-bailout",
     "clean": "rimraf dist"
   },
+  "version": "1.0.0",
+  "dependencies": {
+    "classnames": "^2.2.6",
+    "lodash": "^4.17.11",
+    "moment": "^2.24.0",
+    "prop-types": "^15.7.2",
+    "react-resize-detector": "^4.1.3",
+    "topcoder-react-utils": "^0.7.9"
+  },
+  "peerDependencies": {
+    "react": "^16.8.6"
+  },
   "devDependencies": {
     "@babel/core": "^7.4.4",
     "@babel/plugin-proposal-export-default-from": "^7.2.0",
@@ -51,20 +81,5 @@
     "url-loader": "^1.1.2",
     "webpack": "^4.32.2",
     "webpack-cli": "^3.3.2"
-  },
-  "peerDependencies": {
-    "react": "^16.8.6"
-  },
-  "engines": {
-    "node": "^8.11.2",
-    "npm": "^5.6.0"
-  },
-  "dependencies": {
-    "classnames": "^2.2.6",
-    "lodash": "^4.17.11",
-    "moment": "^2.24.0",
-    "prop-types": "^15.7.2",
-    "react-resize-detector": "^4.1.3",
-    "topcoder-react-utils": "^0.7.9"
   }
 }