|
| 1 | +# clarin-dspace |
1 | 2 |
|
2 | | -[](https://codecov.io/gh/dataquest-dev/DSpace) |
3 | | - |
4 | | -# DSpace |
5 | | - |
6 | | -[DSpace Documentation](https://wiki.lyrasis.org/display/DSDOC/) | |
7 | | -[DSpace Releases](https://github.com/DSpace/DSpace/releases) | |
8 | | -[DSpace Wiki](https://wiki.lyrasis.org/display/DSPACE/Home) | |
9 | | -[Support](https://wiki.lyrasis.org/display/DSPACE/Support) |
10 | | - |
11 | | -## Overview |
12 | | - |
13 | | -DSpace open source software is a turnkey repository application used by more than |
14 | | -2,000 organizations and institutions worldwide to provide durable access to digital resources. |
15 | | -For more information, visit http://www.dspace.org/ |
16 | | - |
17 | | -DSpace consists of both a Java-based backend and an Angular-based frontend. |
18 | | - |
19 | | -* Backend (this codebase) provides a REST API, along with other machine-based interfaces (e.g. OAI-PMH, SWORD, etc) |
20 | | - * The REST Contract is at https://github.com/DSpace/RestContract |
21 | | -* Frontend (https://github.com/DSpace/dspace-angular/) is the User Interface built on the REST API |
22 | | - |
23 | | -Prior versions of DSpace (v6.x and below) used two different UIs (XMLUI and JSPUI). Those UIs are no longer supported in v7 (and above). |
24 | | -* A maintenance branch for older versions is still available, see `dspace-6_x` for 6.x maintenance. |
25 | | - |
26 | | -## Downloads |
27 | | - |
28 | | -* Backend (REST API): https://github.com/DSpace/DSpace/releases |
29 | | -* Frontend (User Interface): https://github.com/DSpace/dspace-angular/releases |
30 | | - |
31 | | -## Documentation / Installation |
32 | | - |
33 | | -Documentation for each release may be viewed online or downloaded via our [Documentation Wiki](https://wiki.lyrasis.org/display/DSDOC/). |
34 | | - |
35 | | -The latest DSpace Installation instructions are available at: |
36 | | -https://wiki.lyrasis.org/display/DSDOC7x/Installing+DSpace |
37 | | - |
38 | | -Please be aware that, as a Java web application, DSpace requires a database (PostgreSQL) |
39 | | -and a servlet container (usually Tomcat) in order to function. |
40 | | -More information about these and all other prerequisites can be found in the Installation instructions above. |
41 | | - |
42 | | -## Running DSpace 7 in Docker |
43 | | - |
44 | | -NOTE: At this time, we do not have production-ready Docker images for DSpace. |
45 | | -That said, we do have quick-start Docker Compose scripts for development or testing purposes. |
46 | | - |
47 | | -See [Running DSpace 7 with Docker Compose](dspace/src/main/docker-compose/README.md) |
48 | | - |
49 | | -## Contributing |
50 | | - |
51 | | -See [Contributing documentation](CONTRIBUTING.md) |
52 | | - |
53 | | -## Getting Help |
54 | | - |
55 | | -DSpace provides public mailing lists where you can post questions or raise topics for discussion. |
56 | | -We welcome everyone to participate in these lists: |
57 | | - |
58 | | -* [[email protected]](https://groups.google.com/d/forum/dspace-community) : General discussion about DSpace platform, announcements, sharing of best practices |
59 | | -* [[email protected]](https://groups.google.com/d/forum/dspace-tech) : Technical support mailing list. See also our guide for [How to troubleshoot an error ](https://wiki.lyrasis.org/display/DSPACE/Troubleshoot+an+error). |
60 | | -* [[email protected]](https://groups.google.com/d/forum/dspace-devel) : Developers / Development mailing list |
61 | | - |
62 | | -Great Q&A is also available under the [DSpace tag on Stackoverflow](http://stackoverflow.com/questions/tagged/dspace) |
63 | | - |
64 | | -Additional support options are at https://wiki.lyrasis.org/display/DSPACE/Support |
65 | | - |
66 | | -DSpace also has an active service provider network. If you'd rather hire a service provider to |
67 | | -install, upgrade, customize or host DSpace, then we recommend getting in touch with one of our |
68 | | -[Registered Service Providers](http://www.dspace.org/service-providers). |
69 | | - |
70 | | -## Issue Tracker |
71 | | - |
72 | | -DSpace uses GitHub to track issues: |
73 | | -* Backend (REST API) issues: https://github.com/DSpace/DSpace/issues |
74 | | -* Frontend (User Interface) issues: https://github.com/DSpace/dspace-angular/issues |
75 | | - |
76 | | -## Testing |
77 | | - |
78 | | -### Running Tests |
79 | | - |
80 | | -By default, in DSpace, Unit Tests and Integration Tests are disabled. However, they are |
81 | | -run automatically by [GitHub Actions](https://github.com/DSpace/DSpace/actions?query=workflow%3ABuild) for all Pull Requests and code commits. |
82 | | - |
83 | | -* How to run both Unit Tests (via `maven-surefire-plugin`) and Integration Tests (via `maven-failsafe-plugin`): |
84 | | - ``` |
85 | | - mvn install -DskipUnitTests=false -DskipIntegrationTests=false |
86 | | - ``` |
87 | | -* How to run _only_ Unit Tests: |
88 | | - ``` |
89 | | - mvn test -DskipUnitTests=false |
90 | | - ``` |
91 | | -* How to run a *single* Unit Test |
92 | | - ``` |
93 | | - # Run all tests in a specific test class |
94 | | - # NOTE: failIfNoTests=false is required to skip tests in other modules |
95 | | - mvn test -DskipUnitTests=false -Dtest=[full.package.testClassName] -DfailIfNoTests=false |
96 | | -
|
97 | | - # Run one test method in a specific test class |
98 | | - mvn test -DskipUnitTests=false -Dtest=[full.package.testClassName]#[testMethodName] -DfailIfNoTests=false |
99 | | - ``` |
100 | | -* How to run _only_ Integration Tests |
101 | | - ``` |
102 | | - mvn install -DskipIntegrationTests=false |
103 | | - ``` |
104 | | -* How to run a *single* Integration Test |
105 | | - ``` |
106 | | - # Run all integration tests in a specific test class |
107 | | - # NOTE: failIfNoTests=false is required to skip tests in other modules |
108 | | - mvn install -DskipIntegrationTests=false -Dit.test=[full.package.testClassName] -DfailIfNoTests=false |
109 | | -
|
110 | | - # Run one test method in a specific test class |
111 | | - mvn install -DskipIntegrationTests=false -Dit.test=[full.package.testClassName]#[testMethodName] -DfailIfNoTests=false |
112 | | - ``` |
113 | | -* How to run only tests of a specific DSpace module |
114 | | - ``` |
115 | | - # Before you can run only one module's tests, other modules may need installing into your ~/.m2 |
116 | | - cd [dspace-src] |
117 | | - mvn clean install |
118 | | -
|
119 | | - # Then, move into a module subdirectory, and run the test command |
120 | | - cd [dspace-src]/dspace-server-webapp |
121 | | - # Choose your test command from the lists above |
122 | | - ``` |
123 | | - |
124 | | -## License |
125 | | - |
126 | | -DSpace source code is freely available under a standard [BSD 3-Clause license](https://opensource.org/licenses/BSD-3-Clause). |
127 | | -The full license is available in the [LICENSE](LICENSE) file or online at http://www.dspace.org/license/ |
128 | | - |
129 | | -DSpace uses third-party libraries which may be distributed under different licenses. Those licenses are listed |
130 | | -in the [LICENSES_THIRD_PARTY](LICENSES_THIRD_PARTY) file. |
131 | | - |
| 3 | +This repository contains the sources for the backend part of clarin-dspace. This version is built on top of DSpace v7. To get more details start at [v7 wiki](https://github.com/ufal/clarin-dspace/wiki/NewHome) or jump directly to the [installation instructions](https://github.com/ufal/clarin-dspace/wiki/NewInstallation) |
0 commit comments