SEDAccord

Features

This project is currently a POC to demonstrate the utility of such a tool for agencies and archivists.

It means there is no true backend: mock data is returned from fake API endpoints in memory via in-memory-data.service.ts, and SIP generation depends on an external beta service. However, these fake endpoints can easily be replaced by true ones, and the frontend code be reused (except for some technical shortcuts, like authentication, indicated in code). It is also missing error handling and form validation.

It currently supports:

• Creation of a new transfer project, allowing to upload one or several directories (simulated for display only).
• Modification of an existing transfer project: update context information and file details.
• Communication between agencies and archivists via a comment system (available for directories/files only) and switching from one of the profile to the other.
  • Agencies can create and share transfer projects.
  • Archivists can see all shared transfers projects and generate SIPs in addition to create new transfer projects.
• Generation of a SIP from a transfer project (local only: service must run on the machine where files are stored).

How-to generate a SIP

• Clone and run https://github.com/hjonin/sipservice on your computer.
• Specify url to the service (LOCAL_SERVER_URL) and path to your files (LOCAL_STORAGE_PATH) in src/app/services/sip.service.ts.
• Export button should now be available under the archivist profile.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Coding style guide

See TSLint (tslint.json) and TSConfig (tsconfig.json) configuration files.

On IntelliJ IDEA:

• Enable the TSLint, JavaScript and TypeScript bundled plugins to start checking your code. It will use the configuration file by default.
• Code style configuration (e.g. for Rearrange Code action) is shared under /.idea/codeStyles.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests [N/A]

Run ng test to execute the unit tests via Karma.

Running end-to-end tests [N/A]

Run ng e2e to execute the end-to-end tests via Protractor.

Deploy to GitHub Pages (prototype only)

Run ng deploy --base-href=/sedaccord-app/ to deploy the Angular application to GitHub Pages.

Browser compatibility

Folder upload feature is not available on Internet Explorer and some outdated browsers (see Directory selection from file input support reference).

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.