Merge pull request #12 from anandvarkeyphilips/development

Git Templates, Error Pages, Docker profiles

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to Enterprise Validator
+
+:+1::tada: First off all, thanks for taking the time to contribute! :tada::+1:
+
+We love participation. We are ready to listen and discuss about changing underlying technologies or anything you love to talk about..
+
+[How Can I Contribute?](#how-can-i-contribute)
+  * [Bug Report Template](ISSUE_TEMPLATE.md)
+  * [Feature Request Template](FEATURE_REQUEST.md)
+  * [Pull Request Template](PULL_REQUEST_TEMPLATE.md)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## I don't want to read this whole thing I just have a question!!!
+
+> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
+
+    If chat is more your speed, you can join the Gitter team:
+
+* [Join the Gitter Chat](https://gitter.im/enterprise-validator/Lobby/)
+
+### How do I make a contribution?
+ Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!
+
+ 1. Find an issue that you are interested in addressing or a feature that you would like to add.
+ 2. Fork the repository associated with the issue to your local GitHub organization. This means that you will have a copy of the repository under **your-GitHub-username/repository-name**.
+ 3. Clone the repository to your local machine using **git clone https://github.com/github-username/repository-name.git**.
+ 4. Create a new branch for your fix using **git checkout -b branch-name-here**.
+ 5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
+ 6. Use **git add insert-paths-of-changed-files-here** to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
+ 7. Use **git commit -m "Insert a short message of the changes made here"** to store the contents of the index with a descriptive message.
+ 8. Push the changes to the remote repository using **git push origin branch-name-here**.
+ 9. Submit a pull request to the upstream repository.
+ 10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
+ 11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
+ 12. Wait for the pull request to be reviewed by a maintainer.
+ 13. Make changes to the pull request if the reviewing maintainer recommends them.
+ 14. Celebrate your success after your pull request is merged!

.github/FEATURE_REQUEST.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+
+**Additional context**
+Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+* **Please check if the PR fulfills these requirements**
+- [ ] The commit message follows our guidelines
+- [ ] Tests for the changes have been added (for bug fixes / features)
+- [ ] Docs have been added / updated (for bug fixes / features)
+
+
+* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
+
+
+
+* **What is the current behavior?** (You can also link to an open issue here)
+
+
+
+* **What is the new behavior (if this is a feature change)?**
+
+
+
+* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)
+
+
+
+* **Other information**:

.github/README.md

@@ -0,0 +1,55 @@
+
+# Welcome to the Enterprise Validator
+
+![GitHub release](https://img.shields.io/github/release/anandvarkeyphilips/enterprise-validator.svg)
+[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/enterprise-validator/Lobby)
+[![GitHub issues](https://img.shields.io/github/issues/anandvarkeyphilips/enterprise-validator.svg)](https://github.com/anandvarkeyphilips/enterprise-validator/issues)
+[![GitHub forks](https://img.shields.io/github/forks/anandvarkeyphilips/enterprise-validator.svg)](https://github.com/anandvarkeyphilips/enterprise-validator/network)
+[![Build Status](http://varkeys-rhel-jenkins.westus.cloudapp.azure.com:8080/buildStatus/icon?job=pipeline-job)](http://varkeys-rhel-jenkins.westus.cloudapp.azure.com:8080/job/pipeline-job/)
+
+### Getting Started
+
+This Spring Boot Fully executable stand alone application is made for enterprises which cannot access/use public
+websites for data validation and manipulation. This app provides,
+
+YAML validator which is better than http://www.yamllint.com as this app follows YAML spec, support multiple doc feature
+which is not supported my YAML Lint. JSON validator and formatter follows the JSON spec at http://json.org/. Also, now 
+you dont have to use https://www.base64decode.org/ as this app also provides options for Decode from and to Base64 format.
+
+Here's the Docker container version of the Application hosted in Microsoft Azure Cloud:  
+**http://enterprise-validator.centralus.azurecontainer.io:8090/enterprise-validator/editor**  
+Here's the fatty jar Application running in Microsoft Azure RHEL VM(May Have Issues):  
+**http://varkeys-rhel-jenkins.westus.cloudapp.azure.com/enterprise-validator/editor**  
+Here's the Openshift version of the Application hosted in Redhat Openshift(May Have Issues):  
+**http://enterprise-validator-enterprise-validator.7e14.starter-us-west-2.openshiftapps.com/editor**  
+
+![Alt text](README-IMAGES/enterprise-validator.png?raw=true "Enterprise Validator Suite")
+
+### Recipe Ingredients
+ * spring-boot-starter-web, spring-boot-starter-freemarker, spring-boot-starter-actuator
+ * springfox-swagger2, springfox-swagger-ui
+ * org.json,snakeyaml, lombok, jackson-databind, spring-boot-test
+
+
+### How to?
+* Click on "BASE 64Encode" to encode to Base64 format.
+* Click on "BASE 64Encode" to decode from Base64 format.
+* Click on "Validate YAML" to validate YAML data.
+* Click on "Validate JSON" to validate JSON data.
+* Click on "Format YAML" to format JSON data.
+* Click on "Share Data" to share the data through configured Mailing App.
+
+
+### Jira
+* [Epic](https://jira.global.atlassian.com/browse/<JIRA-ID>) - Work in Progress
+
+### For help and support,
+Please contact: [Join the Gitter Chat](https://gitter.im/enterprise-validator/Lobby/)
+
+### Change Log
+
+ * You can view the changes in each releases [here](https://github.com/anandvarkeyphilips/enterprise-validator/releases).
+
+### Want to Contribute?
+  * We love participation. We are ready to listen and discuss about changing underlying technologies or anything..
+    You can check the document [here](CONTRIBUTING.md).

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright(c) 2018 Anand Varkey Philips
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pom.xml

@@ -6,8 +6,9 @@
 
     <groupId>io.exnihilo</groupId>
     <artifactId>enterprise-validator</artifactId>
-    <version>2.1.0</version>
+    <version>2.2.0</version>
     <packaging>jar</packaging>
+    <name>Enterprise Validator</name>
 
     <properties>
         <java.version>1.8</java.version>