Code Monkey home page Code Monkey logo

play-starter's Introduction

Flash Job, a sample play app

This app is a two sided, time driven job board : publish your offer / criteria, they will be available one week !

It main purpose is to implement best practices for real-world play 2 apps.

  • compile time DI
  • typing everywhere
  • testing (unit, integration)
  • normalized REST API
    • basic crud
    • search and pagination
    • nice error handling
    • generated documentation
  • application status with build time, git hash & strategic resources status

Requirements

This project works with :

  • Java 8
  • Scala 2.11.7
  • sbt 0.13.11
  • Play framework 2.5.6
  • MongoDB 3.0.2

Configuration

TODO

Running the Application

Running tests

TODO

Running localy

  • start mongo
  • $ sbt run

Deploying in prod

  • Setup a heroku instance
  • add addon for MongoDB (mLab)
  • publish the app

Continuous integration

TODO

Documentation

Api documentation is generated using apiblueprint standard and aglio generator.

To re-generate it you should install sudo npm install -g aglio and run :

aglio -i docs/api.apib -o public/docs/api.html --theme-variables streak --theme-template triple --theme-full-width

Architecture

Scala code

  • global package is a "personal library" & project agnostic
  • com.flashjob package for app code
    • common package is generic code shared throughout the project (such as Config...)
    • domain package is the core logic of the project. It should be framework agnostic as mush as possible
      • models package contains all data definition
      • services package contains project logic
    • infrastructure package is used for code interfacing with external source (database, webservices...)
    • controllers
    • views

Interesting libs

TODO

Credits

play-starter's People

Contributors

loicknuchel avatar

Stargazers

Salman Ahmed avatar Gaël Renoux avatar Yaroslav avatar

Watchers

James Cloos avatar Simón Peters avatar

Forkers

jt9193

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.