Git Product home page Git Product logo

cricket's Introduction

Cricket Microservices Framework for Java.

Building microservices

Add dependency to your pom.xml

<dependency>
    <groupId>org.cricketmsf</groupId>
    <artifactId>cricket</artifactId>
    <version>2.0.0-rc36</version>
</dependency>

Headless CMS

NEED TO BE UPDATED

Downlod criket.jar from Maven Central or build yourself (see below).

Download admin web application

Examples

NEED TO BE UPDATED

Development

Clone repository

$ git clone https://github.com/gskorupa/cricket.git

Build

$ mvn package

More information

Go to https://cricketmsf.org to find more information about the platform.

In case of problems or questions please create issue in the project Github repository.

cricket's People

Contributors

dependabot[bot] avatar gskorupa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

cricket's Issues

service hooks declared for http methods

It's almost ready. Selected methods could be annotated with

// for GET request
@AdapterHook(handlerClassName = "SimpleHttpAdapterIface", requestMethod = "GET") 
// for all not declared methods
@AdapterHook(handlerClassName = "SimpleHttpAdapterIface", requestMethod = "*")

response formatters

Idea:
create Result.toJson, Result.toXML, Result.toCsv - formating response. These methods calls data object's toJson, toXML, toCsv methods or toString.
Developer should implement toJson, toXML, toCsv in data object class.

configurable logs

system logs should be cleaned (replace System.out)
System.out.println only when starting the service
Logging using dedicated adapter

Command line arguments in standalone mode

Executing Cricket from the command line without arguments should print short usage help. Command line parameters

  • --help
  • --conf path_to_config (optional, without it build-in, example config is used)
  • --run

javadoc

  1. javadoc target in build,xml
  2. write class comments

HtmlReaderAdapter

Outbound adapter reading file content.
Configuration parameter:
root - file path

jdbc outbond adapter

Maybe generic JDBC adapter could be helpful as parent to derived implementations.
But maybe not.

display help in standalone mode

Executing Cricket service in standalone mode with --help or -h option should print content of help.txt.
Executing Cricket service in standalone mode with wrong options should print content of help.txt.
help.txt file is included in the jar and accessible from the Service.class as a resource.

EventHook

Registering event hook method in service class
Predefined event types for logging:
LOG_ALL
LOG_FINEST
LOG_INFO
LOG_WARNING
LOG_SEVERE

Example how to send event from adapter, see HttpAdapter

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.