template-service

Template for developing an EOEPCA Service
Explore the docs »
View Demo · Report Bug · Request Feature

Setup for this template

• Replace all "um-buildingblock-template" in readme with your repository's name
• Edit docs to fit your repository
• Un-comment the "notifications" segment in .travis.yml, and input the correct data for slack and/or emails you want to notify
• Edit readme to fit your repository, and delete this part!

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Testing
• Documentation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

![Product Name Screen Shot][product-screenshot]

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: um-buildingblock-template

Built With

• Javalin framework
• Log4j2 + YAML
• Junit 5

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Vagrant
• EOEPCA Development Environment

Installation

1. Get into EOEPCA's development environment

vagrant ssh

3. Clone the repo

git clone https://github.com/EOEPCA/um-buildingblock-template.git

4. Change local directory

cd template-service

Documentation

The component documentation can be found at https://eoepca.github.io/um-buildingblock-template/.

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

EOEPCA mailbox

Project Link: https://github.com/EOEPCA/um-buildingblock-template

Acknowledgements

• README.md is based on this template by Othneil Drew.