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
+56-5Lines changed: 56 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,35 @@
3
3
dspace-angular
4
4
==============
5
5
6
-
> The next UI for DSpace 7, based on Angular Universal.
6
+
> The DSpace User Interface built on [Angular](https://angular.io/), written in [TypeScript](https://www.typescriptlang.org/) and using [Angular Universal](https://angular.io/guide/universal).
7
7
8
-
This project is currently under active development. For more information on the DSpace 7 release see the [DSpace 7.0 Release Status wiki page](https://wiki.lyrasis.org/display/DSPACE/DSpace+Release+7.0+Status)
8
+
Overview
9
+
--------
10
+
11
+
DSpace open source software is a turnkey repository application used by more than
12
+
2,000 organizations and institutions worldwide to provide durable access to digital resources.
13
+
For more information, visit http://www.dspace.org/
14
+
15
+
DSpace consists of both a Java-based backend and an Angular-based frontend.
16
+
17
+
* Backend (https://github.com/DSpace/DSpace/) provides a REST API, along with other machine-based interfaces (e.g. OAI-PMH, SWORD, etc)
18
+
* The REST Contract is at https://github.com/DSpace/RestContract
19
+
* Frontend (this codebase) is the User Interface built on the REST API
20
+
21
+
Downloads
22
+
---------
9
23
10
-
You can find additional information on the DSpace 7 Angular UI on the [wiki](https://wiki.lyrasis.org/display/DSPACE/DSpace+7+-+Angular+UI+Development).
@@ -146,6 +168,9 @@ This will build the application and put the result in the `dist` folder. You ca
146
168
147
169
148
170
### Running the application with Docker
171
+
NOTE: At this time, we do not have production-ready Docker images for DSpace.
172
+
That said, we do have quick-start Docker Compose scripts for development or testing purposes.
173
+
149
174
See [Docker Runtime Options](docker/README.md)
150
175
151
176
@@ -403,8 +428,8 @@ Frequently asked questions
403
428
- You can write your tests next to your component files. e.g. for `src/app/home/home.component.ts` call it `src/app/home/home.component.spec.ts`
404
429
- How do I start the app when I get `EACCES` and `EADDRINUSE` errors?
405
430
- The `EADDRINUSE` error means the port `4000` is currently being used and `EACCES` is lack of permission to build files to `./dist/`
406
-
- What are the naming conventions for Angular 2?
407
-
- See [the official angular 2 style guide](https://angular.io/styleguide)
431
+
- What are the naming conventions for Angular?
432
+
- See [the official angular style guide](https://angular.io/styleguide)
408
433
- Why is the size of my app larger in development?
409
434
- The production build uses a whole host of techniques (ahead-of-time compilation, rollup to remove unreachable code, minification, etc.) to reduce the size, that aren't used during development in the intrest of build speed.
410
435
- node-pre-gyp ERR in yarn install (Windows)
@@ -415,6 +440,32 @@ Frequently asked questions
415
440
- then run `git add yarn.lock` to stage the lockfile for commit
416
441
- and `git commit` to conclude the merge
417
442
443
+
Getting Help
444
+
------------
445
+
446
+
DSpace provides public mailing lists where you can post questions or raise topics for discussion.
447
+
We welcome everyone to participate in these lists:
448
+
449
+
*[dspace-community@googlegroups.com](https://groups.google.com/d/forum/dspace-community) : General discussion about DSpace platform, announcements, sharing of best practices
450
+
*[dspace-tech@googlegroups.com](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).
451
+
*[dspace-devel@googlegroups.com](https://groups.google.com/d/forum/dspace-devel) : Developers / Development mailing list
452
+
453
+
Great Q&A is also available under the [DSpace tag on Stackoverflow](http://stackoverflow.com/questions/tagged/dspace)
454
+
455
+
Additional support options are at https://wiki.lyrasis.org/display/DSPACE/Support
456
+
457
+
DSpace also has an active service provider network. If you'd rather hire a service provider to
458
+
install, upgrade, customize or host DSpace, then we recommend getting in touch with one of our
459
+
[Registered Service Providers](http://www.dspace.org/service-providers).
0 commit comments