SciCat Landing Page Server

A landing page server for publically accessible DOI datasets in SciCat

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

• Angular 17
• Node 20
• SciCat Backend
• MongoDB

Installing

A step by step series of examples that tell you have to get a development env running

How to install:

npm install
set $env to one of the environment file e.g. 
export env=development
npm run build

How to run:

npm start

Running the tests

Unit tests

npm test

End to end tests

e2e tests check content is rendered correctly

npm run e2e

Configuration

Config can be set in one of the three ways, in decreasing order of precedence (see app-config.service):

1. By returning an AppConfig with a backend /config endpoint
2. By serving the AppConfig stored as static asset in /assets/config.json, or
3. By exporting it from a TypeScript file from environmets/environment.ts. The environment.ts file gets replaced based on build configuration passed to ng build (See angular.json).

While many settings in AppConfig are self-explanatory, the following optional settings pertain to optional features:

• statusCode: Can be set to INFO, WARN, or NONE to show a status banner at the top of the page. The message can be set with statusMessage.
• contactEmail: If set, a message with contact email will be shown in the footer of the page.

Deployment

Deploy with Docker

Built With

• NPM - node package manager
• Node - node javascript runtime
• Angular - Web framework

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Gareth Murphy - Initial work - garethcmurphy

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• ESS, PSI