Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 123 lines (70 sloc) 6.403 kb
c50e55b @pr1001 Add README outlining the Lift project and how this repository is situ…
pr1001 authored
1 # The Lift Web Framework
2
3 Lift is the most powerful, most secure web framework available today. There are [Seven Things](http://seventhings.liftweb.net/) that distinguish Lift from other web frameworks.
4
5 Lift applications are:
6
7 - Secure -- Lift apps are resistant to common vulnerabilities including many of the OWASP Top 10
8 - Developer centeric -- Lift apps are fast to build, concise and easy to maintain
9 - Scalable -- Lift apps are high performance and scale in the real world to handle insane traffic levels
10 - Interactive like a desktop app -- Lift's Comet support is unparalled and Lift's ajax support is super-easy and very secure
11
12 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!
13
14 ## Getting Started
15
16 You can create a new Lift project using your favorite build system by adding Lift as a dependency:
17
18 #### sbt 0.11
19
20 Create or update your `project/plugins.sbt` file with the `xsbt-web-plugin`:
21
22 libraryDependencies <+= sbtVersion(v => "com.github.siasia" %% "xsbt-web-plugin" % (v+"-0.2.7"))
23
24 Then, add the plugin and Lift to your `build.sbt` file:
25
26 seq(webSettings :_*)
27
28 libraryDependencies ++= {
ddbea98 @jeppenejsum Update versions to 2.4
jeppenejsum authored
29 val liftVersion = "2.4"
c50e55b @pr1001 Add README outlining the Lift project and how this repository is situ…
pr1001 authored
30 Seq(
31 "net.liftweb" %% "lift-webkit" % liftVersion % "compile",
32 "org.mortbay.jetty" % "jetty" % "6.1.22" % "container",
33 "ch.qos.logback" % "logback-classic" % "0.9.26"
34 )
35 }
36
37 You can [learn more on the wiki](http://www.assembla.com/wiki/show/liftweb/Using_SBT).
38
39 #### Maven:
40
41 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.
42
43 Or, you can add Lift to your `pom.xml` like so:
44
45 <dependency>
46 <groupId>net.liftweb</groupId>
47 <artifactId>lift-mapper_${scala.version}</artifactId>
ddbea98 @jeppenejsum Update versions to 2.4
jeppenejsum authored
48 <version>2.4</version>
c50e55b @pr1001 Add README outlining the Lift project and how this repository is situ…
pr1001 authored
49 </dependency>
50
51 Where `${scala.version}` is `2.8.0`, `2.8.1`, `2.9.1` etc.
52
53 You can [learn more on the wiki](http://www.assembla.com/wiki/show/liftweb/Using_Maven).
54
55 ## Project Organization
56
57 The Lift Framework is divided into several Git repositories, which in turn are 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.
58
59 ### This Repository
60
61 This repository, `framework`, contains the following components:
62
63 #### core
64
65 Core elements used by Lift projects. If you wish to reuse some of Lift's helpers and constructs, such as `Box`, this compenent may be all you need. However, a web application will most likely require one or more of Lift's components.
66
67 #### web
68
69 This component included 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 transative dependency.
70
71 #### persistence
72
73 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.
74
75 ### Other Repostories
76
77 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:
78
79 #### modules
80
81 The [modules](https://github.com/lift/modules) 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 [making an external module](http://www.assembla.com/spaces/liftweb/wiki/Modules) and sharing it with the community.
82
83 #### examples
84
85 The [examples](https://github.com/lift/examples) repository contains the source code for several example Lift applications, including [demo.liftweb.com](http://demo.liftweb.com/).
86
87 ## Building Lift
88
89 If you simply want to use Lift in your project, add Lift as a dependency to your build system or [download the JAR files directly](www.liftweb.net/download).
90
91 If you wish to build Lift from source, checkout this repository and use the included `liftsh` script to build some or all of the components you want.
92
93 git clone https://github.com/lift/framework.git
94 cd framework
42ec31b @pr1001 Added '+update' to instructions for building Lift in README
pr1001 authored
95 ./liftsh +update +publish
c50e55b @pr1001 Add README outlining the Lift project and how this repository is situ…
pr1001 authored
96
97 There is [additional documentation on the wiki](http://www.assembla.com/spaces/liftweb/wiki/Building_Lift).
98
99 ## Additional Resources
100
101 ### Homepage
102
103 The main Lift website is [http://www.liftweb.net](http://www.liftweb.net). The site contains information on the latest Lift releases, a getting started guide, links to several Lift online books, and additional information.
104
105 ### Mailing List
106
107 The Lift Google Group is the official place for support and is an active, friendly community to boot! It can be found at [http://groups.google.com/forum/#!forum/liftweb](http://groups.google.com/forum/#!forum/liftweb).
108
109 ### Wiki
110
111 The Lift wiki is hosted on Assembla and can be found at [http://www.assembla.com/spaces/liftweb/wiki/](http://www.assembla.com/spaces/liftweb/wiki/). Anyone is welcome to contributed to the wiki; you must create an account and watch the Lift project in order to create or edit wiki pages.
112
113 ### ScalaDocs
114
ddbea98 @jeppenejsum Update versions to 2.4
jeppenejsum authored
115 The ScalaDocs for each release of Lift, in additional to the actual JARs, are available on ScalaTools. 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 2.4 release can be accessed at [http://scala-tools.org/mvnsites/liftweb-2.4/](http://scala-tools.org/mvnsites/liftweb-2.4/).
c50e55b @pr1001 Add README outlining the Lift project and how this repository is situ…
pr1001 authored
116
117 ## License
118
119 Lift is open source software released under the **Apache 2.0 license**. You must be a committer with signed comitter agreement to submit patches. You can learn more about Lift's comitter policy on the Lift website.
238de8a @jeppenejsum Add link to Jenkins
jeppenejsum authored
120
121 ## Continuous Integration
122
123 SNAPSHOTs are built at CloudBees: https://lift.ci.cloudbees.com/
Something went wrong with that request. Please try again.