You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+55-51
Original file line number
Diff line number
Diff line change
@@ -13,26 +13,6 @@ Lift applications are:
13
13
14
14
Because Lift applications are written in [Scala](http://www.scala-lang.org), an elegant JVM language, you can still use your favorite Java libraries and deploy to your favorite Servlet Container and app server. Use the code you've already written and deploy to the container you've already configured!
15
15
16
-
## Issues
17
-
18
-
Issues on the Lift GitHub project are intended to describe actionable,
19
-
already-discussed items. Committers on the project may open issues for
20
-
themselves at any time, but non-committers should visit the [Lift mailing
21
-
list](https://groups.google.com/forum/#!forum/liftweb) and start a discussion
22
-
for any issue that they wish to open.
23
-
24
-
## Pull Requests
25
-
26
-
We will accept pull requests into the [Lift codebase](https://github.com/lift)
27
-
if the pull requests meet the following criteria:
28
-
29
-
* The request handles an issue that has been discussed on the [Lift mailing list](http://groups.google.com/forum/#!forum/liftweb)
30
-
and whose solution has been requested (and in general adheres to the spirit of
31
-
the issue guidelines outlined in [CONTRIBUTING.md](https://github.com/lift/framework/blob/master/CONTRIBUTING.md)).
32
-
* The request includes a signature at the bottom of the `/contributors.md` file.
33
-
34
-
For more details, see [CONTRIBUTING.md](https://github.com/lift/framework/blob/master/CONTRIBUTING.md).
35
-
36
16
## Getting Started
37
17
38
18
**Compatibility note:**
@@ -41,30 +21,32 @@ you'll need to use Lift 2.6 until you can upgrade your Java installation.
41
21
42
22
You can create a new Lift project using your favorite build system by adding Lift as a dependency:
43
23
44
-
####sbt
24
+
###With sbt
45
25
46
26
We recommend using the latest sbt version, which is currently 0.13.15, but anything 0.13.6+ will work
47
27
with the instructions below.
48
28
49
29
Create or update your `project/plugins.sbt` file with the `xsbt-web-plugin`:
You can [learn more on the cookbook](http://cookbook.liftweb.net/#LiftFromScratch).
66
-
67
-
#### Maven:
49
+
### With Maven
68
50
69
51
You can use one of the several archetypes -- `lift-archetype-blank`, `lift-archetype-basic`, `lift-archetype-jpa-basic` -- to generate a new Lift project. You must set `archetypeRepository` and `remoteRepositories` to `http://scala-tools.org/repo-releases` or `http://scala-tools.org/repo-snapshots`, depending on whether you are using a release or the latest SNAPSHOT.
70
52
@@ -79,37 +61,63 @@ Or, you can add Lift to your `pom.xml` like so:
79
61
Where `${scala.version}` is `2.11` or `2.12`. Individual patch releases of the Scala compiler (e.g. 2.12.2)
80
62
are binary compatible with everything in their release series, so you only need the first two version parts.
81
63
82
-
You can [learn more on the wiki](http://www.assembla.com/wiki/show/liftweb/Using_Maven).
64
+
You can learn more about Maven integration [on the wiki](http://www.assembla.com/wiki/show/liftweb/Using_Maven).
83
65
84
-
##Project Organization
66
+
### Learning Lift
85
67
86
-
The Lift Framework is divided into several components that are published independently. This organization enables you to use just the elements of Lift necessary for your project and no more.
68
+
There are lots of resources out there for learning Lift. Some of our favorites include:
This repository, `framework`, contains the following components:
73
+
If you've found one that you particularly enjoy, please open a PR to update this README!
91
74
92
-
#### core
75
+
##Issues & Pull Requests
93
76
94
-
Core elements used by Lift projects. If you wish to reuse some of Lift's helpers and constructs, such as `Box`, this component may be all you need. However, a web application will most likely require one or more of Lift's components.
77
+
Per our [contributing guidelines][contribfile], Issues on the Lift GitHub project are intended to
78
+
describe actionable, already-discussed items. Committers on the project may open issues for
79
+
themselves at any time, but non-committers should visit the [Lift mailing
80
+
list](https://groups.google.com/forum/#!forum/liftweb) and start a discussion
81
+
for any issue that they wish to open.
82
+
83
+
We will accept issues and pull requests into the Lift codebase if the pull requests meet the following criteria:
84
+
85
+
* The request is for a [supported version of Lift][supfile]
86
+
* The request adheres to our [contributing guidelines][contribfile], including having been discussed
The Lift Framework is divided into several components that are published independently. This organization enables you to use just the elements of Lift necessary for your project and no more.
97
95
98
-
This component includes all of Lift's core HTTP and web handling. Including `lift-webkit` in your build process should be sufficient for basic applications and will include `lift-core` as a transitive dependency.
96
+
### This Repository
99
97
100
-
#### persistence
98
+
This repository, `framework`, contains the following components:
101
99
102
-
This component includes Mapper and Record, Lift's two ORMs. While you needn't use either and can use the ORM of your choice, Mapper and Record integrate nicely with Lift's idioms. Mapper is an ORM for relational databases, while Record is a broader ORM with support for both SQL databases and NoSQL datastores.
100
+
***core:** Core elements used by Lift projects. If you wish to reuse some of Lift's helpers and
101
+
constructs, such as `Box`, this component may be all you need. However, a web application will most
102
+
likely require one or more of Lift's components.
103
+
***web:** This component includes all of Lift's core HTTP and web handling. Including `lift-webkit`
104
+
in your build process should be sufficient for basic applications and will include `lift-core` as a
105
+
transitive dependency.
106
+
***persistence:** This component includes Mapper and Record, Lift's two ORMs. While you needn't use
107
+
either and can use the ORM of your choice, Mapper and Record integrate nicely with Lift's idioms.
108
+
Mapper is an ORM for relational databases, while Record is a broader ORM with support for both SQL
109
+
databases and NoSQL datastores.
103
110
104
111
### Other Repostories
105
112
106
113
There are a variety of other repositories available on the Lift GitHub page. While many are concerned with building Lift or are build program archetypes, there are two you will probably encounter fairly frequently as a Lift user:
107
114
108
115
#### modules
109
116
110
-
The [modules](https://github.com/liftmodules) repository contains the many add-on modules that are part of the Lift project. If you don't find a module you need here, consider [creating a module](http://www.assembla.com/spaces/liftweb/wiki/Modules) and sharing it with the community.
111
-
112
-
Please note that the modules project does accept pull requests.
117
+
The [modules](https://github.com/liftmodules) organization contains the many add-on modules that are
118
+
part of the Lift project. If you don't find a module you need here, consider
119
+
[creating a module](http://www.assembla.com/spaces/liftweb/wiki/Modules) and sharing it with the
120
+
community.
113
121
114
122
#### examples
115
123
@@ -145,10 +153,6 @@ The Lift wiki is hosted on Assembla and can be found at [http://www.assembla.com
145
153
146
154
The ScalaDocs for each release of Lift, in additional to the actual JARs, are available on the Liftweb.net site. You can access the source code–based documentation for releases via the site's homepage or by navigating directly to the URL for the specific release. For instance, the Lift 3.0 release can be accessed at [http://liftweb.net/api/31/api/](http://liftweb.net/api/31/api/).
147
155
148
-
### Cookbook
149
-
150
-
You can find up-to-date information on the [Lift Cookbook](http://cookbook.liftweb.net/)
151
-
152
156
## License
153
157
154
158
Lift is open source software released under the **Apache 2.0 license**.
0 commit comments