Giter VIP home page Giter VIP logo

swiftengineer / quickstart-scala-sbt-native-image.g8 Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sbchapin/quickstart-scala-sbt-native-image.g8

1.0 0.0 0.0 71 KB

An opinionated quickstart of a fully native-image-compatible Scala sbt-based project. A giter8 template for usage with sbt new. Includes containerization, testing, building, running, logging, argument parsing, and more.

License: Other

Scala 87.70% Dockerfile 12.30%

quickstart-scala-sbt-native-image.g8's Introduction

A Giter8 template for native-image-producing JRE-less scala-sbt starter code for usage with sbt new

Build Status

For more information (quite a lot of information) about what's included in this quickstart, refer to /src/main/g8/README.md.

This information will come along with the template, so you may just want to get on with that.

To get started immediately:

# sbt < 1.3.0
sbt new sbchapin/quickstart-scala-sbt-native-image.g8

# sbt >= 1.3.0 (https://github.com/sbt/sbt/issues/5063)
sbt --supershell=false new sbchapin/quickstart-scala-sbt-native-image.g8

Execute the preceding sbt command wherever you want to start a new scala-sbt project. It will create a new folder in your active directory.

It will ask you four questions:

  • name - will be formatted to the correct type in necessary places (META-INF, packages, README...)
  • organization - must be in the reverse-namespace format.
  • package - must be in the reverse-namespace format (will default to the last two fields intelligently.)
  • maintainer - include name and email for docker and scala artifacts.

Requires:

To develop this:

# Fork it: (https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/)
# ...then...
# Get your fork:
git clone [email protected]:{YOUR_NAME_HERE}/quickstart-scala-sbt-native-image.g8.git
cd quickstart-scala-sbt-native-image.g8
git remote add upstream [email protected]:sbchapin/quickstart-scala-sbt-native-image.g8.git

# Test it continuously: (will extract the project then run tests inside extracted project)
sbt ~test

# Change it:
git checkout -b cool-feature-branch
echo 'Sam sucks' >> README.md
git commit -am 'Stating the evident'

# Test it one last time:
sbt test

# Push it:
git push origin cool-feature-branch

# Pull request it:
# https://github.com/sbchapin/quickstart-scala-sbt-native-image.g8/pulls

Roadmap

  • Keep this baby up to date
  • More robust examples of the existing libraries
  • CI & CD Integrations

LICENSE

This template is distributed without any warranty and dedicated to public domain under the CC0 1.0 Universal (CC0 1.0) Public Domain Dedication license.

quickstart-scala-sbt-native-image.g8's People

Contributors

sbchapin avatar swiftengineer avatar

Stargazers

 avatar

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.