Merge pull request #47 from ARGOeu/devel

Version 1.0.0

.gitignore

@@ -0,0 +1,29 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# IntelliJ
+.idea
+*.ipr
+*.iml
+*.iws

Jenkinsfile

@@ -0,0 +1,47 @@
+pipeline {
+    agent none
+    options {
+        checkoutToSubdirectory('pcc-ui')
+        newContainerPerStage()
+    }
+    environment {
+        PROJECT_DIR='pcc-ui'
+    }
+    stages {
+        stage ('Build and Deploy pcc-ui') {
+            agent {
+                docker {
+                    image 'node:lts-buster'
+                }
+            }
+            steps {
+                echo 'Build pcc-ui'
+                    sh '''
+                        cd $WORKSPACE/$PROJECT_DIR
+                        npm install
+                        CI=false npm run build
+                    '''
+            }
+        }
+    }
+    post {
+        success {
+            script{
+                if ( env.BRANCH_NAME == 'devel' ) {
+                    slackSend( message: ":rocket: New version for <$BUILD_URL|$PROJECT_DIR>:$BRANCH_NAME Job: $JOB_NAME !")
+                    slackSend( message: ":satellite: New version of <$BUILD_URL|$PROJECT_DIR> built successfully to devel!")
+                }
+                else if ( env.BRANCH_NAME == 'master' ) {
+                    slackSend( message: ":rocket: New version for <$BUILD_URL|$PROJECT_DIR>:$BRANCH_NAME Job: $JOB_NAME !")
+                }
+            }
+        }
+        failure {
+            script{
+                if ( env.BRANCH_NAME == 'master' || env.BRANCH_NAME == 'devel' ) {
+                    slackSend( message: ":rain_cloud: Build Failed for <$BUILD_URL|$PROJECT_DIR>:$BRANCH_NAME Job: $JOB_NAME")
+                }
+            }
+        }
+    }
+}

README.md

@@ -1,2 +1,38 @@
-# pcc-ui
-PCC UI
+# PCC-UI
+
+A ReactJS application for the PID Central Catalogue (PCC)
+
+## Configuration
+
+The pcc-ui application provides a simple way to configure connection through the `config.js` file. Before using just set the `endpoint` parameter appropriately.
+
+The `public` directory of the project may host specific assets such as the `favicon.ico` and the `logo.svg`.
+
+## Installation
+
+### Development mode
+
+1. `git clone https://github.com/ARGOeu/pcc-ui.git`
+2. `cd pcc-ui`
+3. `npm install`
+4. `npm start`
+
+This will run the app in the development mode.Open http://localhost:3000 to view it in your browser.
+
+The page will reload when you make changes.
+You may also see any lint errors in the console.
+
+### Production mode
+
+1. `git clone https://github.com/ARGOeu/pcc-ui.git`
+2. `cd pcc-ui`
+3. `npm install`
+4. `npm run build`
+
+This will build the app for production to the `build` folder.
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.