README.md 4.94 KB
Newer Older
1 2
## Spring Framework
The Spring Framework provides a comprehensive programming and configuration
3
model for modern Java-based enterprise applications -- on any kind of deployment
4 5 6 7 8
platform. A key element of Spring is infrastructural support at the application
level: Spring focuses on the "plumbing" of enterprise applications so that teams
can focus on application-level business logic, without unnecessary ties to
specific deployment environments.

9 10 11
The framework also serves as the foundation for [Spring Integration][], [Spring Batch][]
and the rest of the Spring [family of projects][]. Browse the repositories under
the [Spring organization][] on GitHub for a full list.
12

13 14 15 16
## Code of Conduct
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.adoc).
By participating, you  are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.

17
## Downloading Artifacts
18
See [downloading Spring artifacts][] for Maven repository information. Unable to
19 20
use Maven or other transitive dependency management tools?
See [building a distribution with dependencies][].
21 22 23 24

## Documentation
See the current [Javadoc][] and [reference docs][].

25
## Getting Support
26
Check out the [spring][spring tags] tags on [Stack Overflow][]. [Commercial support][]
27 28 29
is available too.

## Issue Tracking
30
Report issues via the [Spring Framework JIRA][]. Understand our issue management
31 32 33 34 35
process by reading about [the lifecycle of an issue][]. Think you've found a
bug? Please consider submitting a reproduction project via the
[spring-framework-issues][] GitHub repository. The [readme][] there provides
simple step-by-step instructions.

36
## Building from Source
37 38
The Spring Framework uses a [Gradle][]-based build system. In the instructions
below, [`./gradlew`][] is invoked from the root of the source tree and serves as
39
a cross-platform, self-contained bootstrap mechanism for the build.
40

41
### Prerequisites
42

43
[Git][] and [JDK 8 update 20 or later][JDK8 build]
44

45 46 47 48 49
Be sure that your `JAVA_HOME` environment variable points to the `jdk1.8.0` folder
extracted from the JDK download.

### Check out sources
`git clone git@github.com:spring-projects/spring-framework.git`
50

51
### Import sources into your IDE
52
Run `./import-into-eclipse.sh` or read `import-into-idea.md` as appropriate.
53 54 55 56 57 58 59
> **Note:** Per the prerequisites above, ensure that you have JDK 8 configured properly in your IDE.

### Install all spring-\* jars into your local Maven cache
`./gradlew install`

### Compile and test; build all jars, distribution zips, and docs
`./gradlew build`
60 61 62 63 64 65 66

... and discover more commands with `./gradlew tasks`. See also the [Gradle
build and release FAQ][].

## Contributing
[Pull requests][] are welcome; see the [contributor guidelines][] for details.

67 68 69 70
## Staying in Touch
Follow [@SpringCentral][] as well as [@SpringFramework][] and its [team members][]
on Twitter. In-depth articles can be found at [The Spring Blog][], and releases
are announced via our [news feed][].
71 72 73 74

## License
The Spring Framework is released under version 2.0 of the [Apache License][].

75 76 77 78 79 80 81 82
[Spring Integration]: https://github.com/spring-projects/spring-integration
[Spring Batch]: https://github.com/spring-projects/spring-batch
[family of projects]: http://spring.io/projects
[Spring organization]: https://github.com/spring-projects
[downloading Spring artifacts]: https://github.com/spring-projects/spring-framework/wiki/Downloading-Spring-artifacts
[building a distribution with dependencies]: https://github.com/spring-projects/spring-framework/wiki/Building-a-distribution-with-dependencies
[Javadoc]: http://docs.spring.io/spring-framework/docs/current/javadoc-api/
[reference docs]: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/
83
[spring tags]: http://spring.io/questions
84
[Stack Overflow]: http://stackoverflow.com/faq
85 86 87 88 89
[Commercial support]: http://spring.io/services
[Spring Framework JIRA]: https://jira.spring.io/browse/SPR
[the lifecycle of an issue]: https://github.com/spring-projects/spring-framework/wiki/The-Lifecycle-of-an-Issue
[spring-framework-issues]: https://github.com/spring-projects/spring-framework-issues#readme
[readme]: https://github.com/spring-projects/spring-framework-issues#readme
90 91 92
[Gradle]: http://gradle.org
[`./gradlew`]: http://vimeo.com/34436402
[Git]: http://help.github.com/set-up-git-redirect
93
[JDK8 build]: http://www.oracle.com/technetwork/java/javase/downloads
94
[Gradle build and release FAQ]: https://github.com/spring-projects/spring-framework/wiki/Gradle-build-and-release-FAQ
95
[Pull requests]: http://help.github.com/send-pull-requests
96 97 98
[contributor guidelines]: https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md
[@SpringFramework]: https://twitter.com/springframework
[@SpringCentral]: https://twitter.com/springcentral
99
[team members]: https://twitter.com/springframework/lists/team/members
100 101
[The Spring Blog]: http://spring.io/blog/
[news feed]: http://spring.io/blog/category/news
102
[Apache License]: http://www.apache.org/licenses/LICENSE-2.0