Skip to content

Commit e6c3757

Browse files
committed
add Quickstart section
1 parent f9d4696 commit e6c3757

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

_posts/2015-05-28-quickstart.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: page
3+
title: "Quickstart"
4+
category: dev
5+
date: 2015-05-28 17:09:53
6+
order: 5
7+
---
8+
9+
There are two really good reasons to create a Pippo quickstart. The first is if you just want to get started using Pippo quickly.
10+
The quickstart will set up a ready-to-use project in under a minute (depending on your bandwidth). Another great reason to create a quickstart is to accompany a bug report.
11+
If you report a bug in [Github](https://github.com/decebals/pippo/issues) or on the [mailing list](http://groups.google.com/group/pippo-java), the core developers may not be able to recreate it easily.
12+
13+
Quickstarts are made from a Maven archetype. So, you will need to have [Maven](http://maven.apache.org) installed and working (from the command line) before following this.
14+
15+
Creating a quickstart provides only a very basic starting point for your Pippo project. If you are looking for examples of how to use Pippo and its various features, please refer to the [demo](/doc/demo.html) projects instead!
16+
17+
To create your project you must follow these steps:
18+
19+
- install [pippo-quickstart]({{ projecturl }}/maven-archetypes/quickstart) archetype on your computer (this step is **OPTIONAL**; the archetype is also available on Maven Central Repository):
20+
21+
```
22+
cd <PIPPO_HOME>/maven-archetypes/quickstart
23+
mvn install
24+
```
25+
26+
- create your quickstart project:
27+
28+
```
29+
mvn archetype:generate \
30+
-DarchetypeGroupId=ro.pippo \
31+
-DarchetypeArtifactId=pippo-quickstart \
32+
-DarchetypeVersion=0.5.0-SNAPSHOT \
33+
-DgroupId=com.mycompany \
34+
-DartifactId=myproject
35+
```
36+
maybe you want to change `groupId`, `artifactId`
37+
38+
- run your application from command line:
39+
40+
```
41+
cd myproject
42+
mvn compile exec:java
43+
```
44+
now your application is available at `http://localhost:8338`
45+
46+
If you want to create the `war` file of your application then you must run:
47+
48+
```
49+
mvn -Pwar package
50+
```
51+
The `-Pwar` parameter (switch to `war` profile) excludes the libraries of the embedded web server from the war file. The war file is available in `target` folder.

0 commit comments

Comments
 (0)