website-source/docs/getting-started/index.html at master · ebean-orm/website-source · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<html>
<head>
  <title>Getting started | Ebean</title>
  <meta name="layout" content="_layout2/base-docs.html"/>
  <meta name="bread1" content="Getting started" href="/docs/getting-started/"/>
  <#assign page_edit_href="/docs/getting-started/index.html">
  <#assign n0_start="active">
</head>
<body>
<h2 id="prerequisites">Prerequisite - Java 11</h2>
<p>
  Ebean 13+ requires Java 11. Please upgrade as soon as you can.
</p>
<h2 id="Jakarata">jakarta and javax persistence</h2>
<p>
  Ebean 14.x/15.x use <code>jakarta.persistence</code>.
  To use <code>javax.persistence</code> use Ebean version <b>14.x-javax</b>.
</p>

<p>&nbsp;</p>
<h3 id="examples">Example projects</h3>
<p>
  You can explore example Java projects for
  <a href="https://github.com/ebean-orm-examples/example-java8">Maven</a>,
  <a href="https://github.com/ebean-orm-examples/example-gradle-java">Gradle</a>
  or example Kotlin projects using
  <a href="https://github.com/ebean-orm-examples/example-kotlin">Maven</a> or
  <a href="https://github.com/ebean-orm-examples/example-gradle-kotlin">Gradle</a>.
</p>
<p>
  For other example projects like PostGIS etc goto <a href="/docs/examples">/docs/examples</a>.
</p>

<p>&nbsp</p>

<h2 id="ai-guides">Step-by-step guides (for AI agents and developers)</h2>
<p>
  If you use a skill-aware coding tool, install the <code>ebean-orm</code> agent skill first.
  See <a href="/docs/agents/skills">Agent Skills for Ebean Projects</a>.
</p>
<p>
  Prescriptive step-by-step guides for adding Ebean to an existing project are available
  in the Ebean GitHub repository. These guides are written to be followed by AI coding
  agents (Copilot, Cursor, Claude Code, etc.) as well as human developers.
</p>
<ul>
  <li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-postgres-maven-pom.md">Add Ebean + PostgreSQL — Maven POM setup</a></li>
  <li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-postgres-database-config.md">Database configuration (DataSourceBuilder + DatabaseBuilder)</a></li>
  <li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-postgres-test-container.md">Test container setup (PostgreSQL / PostGIS via Docker)</a></li>
  <li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/add-ebean-db-migration-generation.md">Database migration generation</a></li>
  <li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/lombok-with-ebean-entity-beans.md">Using Lombok with Ebean entity beans</a></li>
  <li><a href="https://github.com/ebean-orm/ebean/blob/HEAD/docs/guides/README.md">Full guide index</a></li>
</ul>

<p>&nbsp</p>

<h2 id="ide">Install IDE Plugin</h2>
<p>
  Ebean uses bytecode enhancement to provide <code>dirty checking</code> and <code>lazy loading</code>.
  We using tooling via IDEA, Eclipse, Maven and Gradle plugins to perform this enhancement.
</p>
<p>
  Install the Plugin for <a class="btn" href="/docs/getting-started/intellij-idea">IntelliJ IDEA</a>  or
  <a class="btn" href="/docs/getting-started/eclipse-ide">Eclipse IDE</a>.
</p>

</body>
</html>