core3 - Example Workflow Engine + UI

Example Scala Play 2.6 app showcasing a way to build a combined backend and frontend service with core3.

Getting Started

• Clone repo
• Get Redis (example setup)
• Add static.conf (see the reference config for more info)
• sbt run -Dhttps.port=<some local port> -Dhttp.port=disabled -Dc3ec.console=enabled

For a split engine/UI implementation, see core3-example-engine and core3-example-ui.

Supported data sources

• Redis (tested on 3.2.5, 3.2.8)

Supported auth providers

• Local - local credentials DB

Deployment

Deploying a Play 2.6 application

Testing

Only one test is provided and it is used to create a few test users. See the spec for details.

sbt test

Required options:

-Dserver.static.database.redis.secret=<some password>

Interesting files

• app/Module - component setup
• conf/routes - routing config
• app/ConsoleStart - enables the system management console
• app/controllers/System - Example actions for handling login, logout, public and authorized pages.
• views - Twirl HTML templates
• public/js/main.js - RequireJS init
• public/js/core3_example_ui - client-side code

Built With

• Scala 2.12.3
• sbt 0.13.16
• core3 - Core framework
• rediscala - Redis data layer support
• jQuery
• RequireJS
• UIkit

Versioning

We use SemVer for versioning.

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details

Copyright 2017 Interel

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.