Fedora Commons Repository

![Build](https://github.com/fcrepo/fcrepo/workflows/Build/badge.svg) [![codecov](https://codecov.io/github/fcrepo/fcrepo/graph/badge.svg?token=GcgUWil0ni)](https://codecov.io/github/fcrepo/fcrepo)

[JavaDocs](http://docs.fcrepo.org/) | 
[Fedora Wiki](https://wiki.lyrasis.org/display/FF) | 
[Use cases](https://wiki.lyrasis.org/display/FF/Use+Cases) |
[Technical Docs](https://wiki.lyrasis.org/display/FEDORA6x/) |
[REST API](https://wiki.lyrasis.org/display/FEDORA6x/RESTful+HTTP+API)

Fedora is a robust, modular, open source repository system for the management and dissemination of digital content.
It is especially suited for digital libraries and archives, both for access and preservation. It is also used to
provide specialized access to very large and complex digital collections of historic and cultural materials as well
as scientific data. Fedora has a worldwide installed user base that includes academic and cultural heritage
organizations, universities, research institutions, university libraries, national libraries, and government agencies.
The Fedora community is supported by the stewardship of the [Lyrasis](http://www.lyrasis.org) organization.

## Technical goals:
* Enhanced preservation sensibilities including preservation storage layer transparency
* Improved scalability and performance
* More flexible storage options
* Improved durability
* Improved reporting and metrics

## Downloads

The current web-deployable version of Fedora can be downloaded from the 
[Lyrasis website](https://wiki.lyrasis.org/display/FF/Downloads)
or from [Github](https://github.com/fcrepo/fcrepo/releases). These artifacts can be deployed directly in a Jetty or Tomcat container
as described in the guide to [deploying Fedora](https://wiki.lyrasis.org/display/FEDORA6x/Guides).

## Contributing

Contributions to the Fedora project are always welcome. These may take the form of testing the application, clarifying documentation
or writing code.

Code contributions will take the form of pull requests to this repository. New developers may wish to review 
[this guide](https://wiki.lyrasis.org/display/FF/Guide+for+New+Developers)
as it explains both the process and standards for test coverage, style and documentation.

## Getting help

There are two community mailing lists where you can post questions or raise topics for discussion. Everyone is
welcome to subscribe and participate.

* https://groups.google.com/d/forum/fedora-community
* https://groups.google.com/d/forum/fedora-tech

Many of the developers are available on Slack in the  `#tech` and `bleeding-edge` channels, hosted by [fedora-project
.slack.com](https://fedora-project.slack.com/).

In addition, there are weekly Zoom [technical calls](https://wiki.lyrasis.org/display/FF/Meetings) which anyone may
 join.

## Building and running Fedora from source

System Requirements
* Java 21
* Maven 3.6.3

```bash
$ git clone https://github.com/fcrepo/fcrepo.git
$ cd fcrepo
$ mvn install
```

The compiled Fedora war file can be found in `./fcrepo-webapp/target`. This can be deployed directly to a servlet container as
described in the [deployment guide](https://wiki.lyrasis.org/display/FEDORA6x/Deployment).


If deployed locally using a war file called `fcrepo.war`, the web application will typically be available at
http://localhost:8080/fcrepo/rest.

There is a convenient method for *testing* the Fedora application by launching it directly from the command line.

Use the maven command: `mvn jetty:run`

```
$ cd fcrepo-webapp
$ mvn jetty:run
```

For this method, your Fedora repository will be available at: [http://localhost:8080/rest/](http://localhost:8080/rest/)

Note: You may need to set the $JAVA_HOME property, since Maven uses it to find the Java runtime to use, overriding your PATH.
`mvn --version` will show which version of Java is being used by Maven, e.g.:

```bash
Java version: 21.0.8, vendor: Homebrew, runtime: /opt/homebrew/Cellar/openjdk@21/21.0.8/libexec/openjdk.jdk/Contents/Home
Default locale: en_US, platform encoding: UTF-8
```

To set your $JAVA_HOME environment variable:

```bash
export JAVA_HOME=/path/to/java
```