Skip to content
This repository has been archived by the owner on Mar 4, 2021. It is now read-only.

Commit

Permalink
Documentation and infrastructure changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jaguililla committed Jan 29, 2015
1 parent 1ca7ce8 commit f39ad6e
Show file tree
Hide file tree
Showing 11 changed files with 72 additions and 97 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
language: java
jdk: oraclejdk8
after_success: gradle clean check jacocoTestReport coveralls
after_success: gradle/wrapper clean check jacocoTestReport coveralls
File renamed without changes
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ subprojects {
apply plugin: 'com.github.kt3k.coveralls'

group = 'sabina'
version = '2.0.1-SNAPSHOT'
version = '2.1.0-SNAPSHOT'
description = 'A Sinatra inspired Java web framework'

repositories {
Expand Down
11 changes: 0 additions & 11 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
#systemProp.http.proxyHost=
#systemProp.http.proxyPort=
#systemProp.http.proxyUser=
#systemProp.http.proxyPassword=
#systemProp.http.nonProxyHosts=

#systemProp.https.proxyHost=
#systemProp.https.proxyPort=
#systemProp.https.proxyUser=
#systemProp.https.proxyPassword=
#systemProp.https.nonProxyHosts=

org.gradle.daemon=true

51 changes: 25 additions & 26 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,25 @@
Sabina - a Sinatra inspired web framework
=========================================

Sabina 2.0.1 is now available on [JCenter]!!! (TODO Add JCenter link)
Sabina 2.1.0 is now available on [JCenter]!!!

```groovy
dependencies {
compile 'sabina:http:2.1.0'
}
```

```xml
<dependency>
<groupId>com.sabina</groupId>
<artifactId>sabina</artifactId>
<version>1.0.0</version>
<groupId>sabina</groupId>
<artifactId>http</artifactId>
<version>2.1.0</version>
</dependency>
```

API Docs: [Core](http://there4.co/sabina/core/) [Extra](http://there4.co/sabina/core/)
API Docs: [Core](http://there4.co/sabina/http/) [Extra](http://there4.co/sabina/http/)

[JCenter]:
[JCenter]: TODO Add JCenter link


Getting started
Expand All @@ -31,12 +37,10 @@ Getting started
```java
import static sabina.Sabina.*;

public class HelloWorld {
public static void main (String[] args) {
serve (
get ("/hello", it -> "Hello World!")
);
}
public class HiWorld {
public static void main (String[] args) {
get ("/hello", it -> "Hi World!").start ();
}
}
```

Expand All @@ -55,29 +59,29 @@ Examples
Check out and try the examples in the source code.

Simple example showing some basic functionality ([SimpleExample.java][Simple])
[Simple]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/SimpleExample.java
[Simple]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/SimpleExample.java

A simple CRUD example showing howto create, get, update and delete book resources ([Books.java][Books])
[Books]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/Books.java
[Books]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/Books.java

Example showing a very simple (and stupid) authentication filter that is executed before all
other resources ([FilterExample.java][Filter])
[Filter]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/FilterExample.java
[Filter]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/FilterExample.java

Example showing how to use attributes ([FilterExampleAttributes.java][FilterAttributes])
[FilterAttributes]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/FilterExampleAttributes.java
[FilterAttributes]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/FilterExampleAttributes.java

Example showing how to serve static resources ([StaticResources.java][StaticResources])
[StaticResources]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/StaticResources.java
[StaticResources]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/StaticResources.java

Example showing how to define content depending on accept type ([JsonAcceptTypeExample.java][JsonAcceptType])
[JsonAcceptType]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/JsonAcceptTypeExample.java
[JsonAcceptType]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/JsonAcceptTypeExample.java

Example showing how to render a view from a template ([FreeMarkerExample.java][FreeMarker])
[FreeMarker]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/FreeMarkerExample.java
[FreeMarker]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/FreeMarkerExample.java

Example of using Transformer. ([TransformerExample.java][Transformer])
[Transformer]: //github.com/jamming/sabina/tree/master/core/src/test/java/sabina/examples/TransformerExample.java
[Transformer]: //github.com/jamming/sabina/tree/master/http/src/test/java/sabina/examples/TransformerExample.java


LICENSE
Expand All @@ -99,13 +103,11 @@ and limitations under the License.
TODO
----

* Add badges to site
* Add social buttons to site
* Fix documentation site styles and pages
* Add Travis links, huboard, issues, etc.
* Add Travis links, huboard, issues, etc. (in reference documentation)

* Add optimize 'profile'
* Create unit tests

* Integrate with:
* http://jackson.codehaus.org
Expand All @@ -118,7 +120,4 @@ TODO
* Helper for JDBC

* Example project (command to fetch and start, deployment heroku, building executable WAR)
* Start child processes (clones) of the microservice
* Manage versions
* Deploy GH pages in Travis: after_success: ./gradlew cobertura coveralls jbake publishGhPages
* Create 'amqp' module for async queues communication (with producer and consumer)
9 changes: 4 additions & 5 deletions site/assets/css/base.css
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ div#wrap { margin-top: 100px; }
p#header { text-align: center; }

/* For the license */
/*
dl { display: table; }
dt { display: table-row; }
dd { margin-left: 10px; }
*/
dd {
margin-left: 2em;
margin-top: -1.35em;
}
31 changes: 0 additions & 31 deletions site/content/download.md

This file was deleted.

2 changes: 1 addition & 1 deletion site/content/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ status=published
API Documentation
=================
* [Core Javadoc](core/index.html)
* [HTTP Javadoc](http/index.html)
* [Extra Javadoc](extra/index.html)
6 changes: 6 additions & 0 deletions site/content/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ Why not use Spark?
TODO
* Working tests
* All in one project (http, extra, documentation)
* Coverage and deployment
* Undertow backend
* Multiple servers
Okey, so why use Sabina?
------------------------
Expand Down
52 changes: 33 additions & 19 deletions site/templates/index.gsp
Original file line number Diff line number Diff line change
@@ -1,34 +1,48 @@
<%include "header.gsp"%>
<%include "menu.gsp"%>

<p id="header">
<div class="row">
<div class="col-md-6 col-xs-6 col-sm-3">
<img
src="http://raw.githubusercontent.com/jamming/sabina/gh-pages/sabina-logo.png"
alt="Project Logo"/>
</div>
<div class="col-md-6 col-xs-6 col-sm-3">
<h1>Sabina</h1>
<h2>
A Sinatra inspired micro web framework for quickly creating web applications in Java with
minimal effort
</h2>
</div>
</div>

<p>
<a href="https://travis-ci.org/jamming/sabina">
<img
src="http://raw.githubusercontent.com/jamming/sabina/gh-pages/sabina-logo.png"
alt="Project Logo"/>
<h1>
A Sinatra inspired micro web framework for quickly creating web applications in Java with
minimal effort
</h1>
src="https://travis-ci.org/jamming/sabina.svg?branch=master"
alt="Build Img"
style="max-width:100%;">
</a>
<a href="https://coveralls.io/r/jamming/sabina">
<img
src="https://img.shields.io/coveralls/jamming/sabina.svg"
alt="Coverage Img"
style="max-width:100%;">
</a>
</p>

<h2>News</h2>

<p>Sabina 2.0.0 re-written for Java 8 and Lambdas available on Bintray and Maven central!</p>

<h2>Quick start</h2>

<p>Add the Sabina maven dependency and you're ready to go:</p>
<p>Add the Sabina dependency and you're ready to go:</p>

<pre>
<code class="java">
import static sabina.Sabina.*;
<code class="java">import static sabina.Sabina.*;

public class HelloWorld {
public static void main(String[] args) {
get(&quot;/hello&quot;, it -&gt; &quot;Hello World&quot;);
public class HiWorld {
public static void main (String[] args) {
get(&quot;/hello&quot;, it -&gt; &quot;Hi World!&quot;).start ();
}
}
</code>
}</code>
</pre>

<h2>Ignite and view at</h2>
Expand Down
3 changes: 1 addition & 2 deletions site/templates/menu.gsp
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@

<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="${root}">Home</a></li>
<li><a href="${root}index.html">Home</a></li>
<li><a href="${root}why.html">Why</a></li>
<li><a href="${root}readme.html">Readme</a></li>
<li><a href="${root}download.html">Download</a></li>
<li><a href="${root}reference.html">Reference</a></li>
<li><a href="${root}license.html">License</a></li>
<li><a href="${root}contact.html">Contact</a></li>
Expand Down

0 comments on commit f39ad6e

Please sign in to comment.