README.md

template-service

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

Table of Contents

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

About The Project

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: template-svce, twitter_handle, email

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/template-svce.git

4. Change local directory

cd template-service

Testing

• ./gradlew build runs only the unit tests
• ./gradlew integrationTest runs only the integration tests (it compiles all source code beforehand). It does not package or deploy a build. This is assumed to have been done in a prior build pipeline step.

Documentation

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

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

Running the template service

Just execute the run task in Gradle

./gradlew run

Upgrading Gradle Wrapper

Change the version number in the build.gradle wrapper task then run:

./gradlew wrapper --gradle-version=4.10.2 --distribution-type=bin

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

Your Name - @twitter_handle - email

Project Link: https://github.com/EOEPCA/template-svce

Acknowledgements

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