/flapjack

A tasty java stack for building modern web applications.

Primary LanguageJava

Flapjack

A tasty java stack for building modern web applications.

What is Flapjack?

Flapjack is a java webapp that comes with functionality virtually any site is going to need.
Use it as a starting point for building your own web applications.

Why use Flapjack?

Flapjack brings together a bunch of good tech all nicely integrated together and ready to use.

  • Jersey: for REST, JAX-RS style
  • Guice: for injecting dependencies
  • Postgres: for databasing
  • Hibernate: for ORMing
  • Ehcache: for caching
  • Metrics: for troubleshooting
  • Jackson: for JSONing
  • Cambridge Templates: for templating

The functionality that you get out of the box from Flapjack includes:

  • User account creation, login, and session management.
  • Integration with Mozilla Persona for login.
  • Database caching.
  • Cool server metrics using Metrics Watcher.
  • And much more!

How do I get up and running?

Flapjack doesn't mandate any particular setup per-se, but what follows is likely the path of least resistance to getting started:

  1. Put JDK7 or better on your machine
  2. Install Postgress.app
  3. Install Eclipse

Then:

$ git clone https://github.com/depsypher/flapjack
$ cd flapjack
$ ./extras/setup.sh

Then:

  1. File > Import > Existing Project in Eclipse
  2. Right-click FlapjackRunner.launch in Eclipse and choose Run or Debug
  3. Go here for the app: http://localhost:8080/flapjack/
  4. Go here for metrics: http://localhost:8080/flapjack/metrics