Skip to content
SciCat open data catalogue web client
TypeScript HTML CSS JavaScript Groovy Shell
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
CI use update logo Aug 14, 2019
documentation
e2e
reports
scripts
src
.dockerignore
.editorconfig
.gitignore
.travis.yml
.zenodo.json
CONTRIBUTING.md
Dockerfile
Dockerfile2
LICENSE
README.md
angular.json
karma.conf.js
ngsw-config.json
package-lock.json
package.json
tslint.json
typings.json

README.md

Catanie SciCat Client

sci-cat-logo

Build Status DeepScan grade DOI Greenkeeper badge code style: prettier Coverage Status

Summary

A data catalogue web application to provide a searchable interface for datasets, as well as the option to carry out actions (i.e. archiving and publishing) and acts as a place to reference datasets used in publications. See documentation at scicatproject

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 v8 or higher
npm version 6 or higher
node version 10 or higher

Installing

Use git to clone the repository

git clone https://github.com/SciCatProject/catanie
cd catanie

First install the required modules

npm install

Then build with the Angular CLI

npx ng build

You can deploy a test server with the following command:

npx ng serve 

Running the unit tests

To run the unit tests, type:

npm test

End to end tests

To run the end to end tests, type:

npm run e2e

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.

License

This project is licensed under the GPL License - see the LICENSE file for details

Acknowledgments

Scicat is developed at PSI, ESS and MAXIV with in-kind funding from ESS and from the European Union Framework Programme for Research and Innovation Horizon 2020, under grant agreement 676548, “BrightnESS”.

You can’t perform that action at this time.