https://github.com/elasticio/petstore-component-java

elastic.io component for the Petstore API
https://github.com/elasticio/petstore-component-java

component elasticio integration ipaas java rest-api

Last synced: 3 days ago
JSON representation

elastic.io component for the Petstore API

• Host: GitHub
• URL: https://github.com/elasticio/petstore-component-java
• Owner: elasticio
• Created: 2017-01-27T13:01:38.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-17T12:13:07.000Z (7 months ago)
• Last Synced: 2024-04-17T13:34:19.496Z (7 months ago)
• Topics: component, elasticio, integration, ipaas, java, rest-api
• Language: Java
• Size: 252 KB
• Stars: 1
• Watchers: 10
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# petstore-component-java

> Petstore Java component template for the [elastic.io platform](http://www.elastic.io "elastic.io platform")

This is a component template which we commonly refer as **the first step of the development** for creating a component to deploy into our platform. This component comes with a basic architecture which can be used on our platform. You can clone it and use it. However, **if you plan to deploy it into [elastic.io platform](https://www.elastic.io "elastic.io platform") you must follow sets of instructions to succeed**.

## Before you Begin

Before you can deploy any code into our system **you must be a registered elastic.io platform user**. Please see our home page at [https://www.elastic.io](https://www.elastic.io) to learn how.

> Any attempt to deploy a code into our platform without a registration would be rejected.

After the registration and opening of the account you must **[upload your SSH Key](http://go2.elastic.io/manage-ssh-keys)** into our platform.

> If you fail to upload you SSH Key you will get **permission denied** error during the deployment.

## Getting Started

After registration and uploading of your SSH Key you can proceed to deploy it into our system. At this stage we suggest you to:

* [Create a team](http://go2.elastic.io/manage-teams) to work on your new component. This is not required but will be automatically created using random naming by our system so we suggest you name your team accordingly.

* [Create a repository](http://go2.elastic.io/manage-repositories) where your new component is going to *reside* inside the team that you have just created.

```bash

$ git clone https://github.com/elasticio/petstore-component-java.git your-repository

$ cd your-repository

```

Now you can edit your version of **petstore-component-java** component and build your desired component. Or you can just ``PUSH``it into our system to see the process in action:

```bash

$ git remote add elasticio [email protected]:your-repository.git

$ git push elasticio master

```

Obviously the naming of your team and repository is entirely up-to you and if you do not put any corresponding naming our system will auto generate it for you but the naming might not entirely correspond to your project requirements.

## File Structure

The structure of **petstore-component-java** component is quite flexible. [elastic.io platform](https://www.elastic.io) expects only two files to be present in the main directory. These are the ``component.json`` and ``package.json``. Our documentation on [how to build a component in Java](http://go2.elastic.io/build-java-component) has more about each file and their function.