The HIFIS Research Software Directory is a place to discover and promote research software. Designed for Research Software Engineers and Scientists, it aims to foster FAIR and reuseability of software.
Welcome to the HIFIS-Fork of the Research Software Directory. This fork contains adjustments for the Helmholtz version of the RSD.
::: End of HIFIS notes
This repo contains the new RSD-as-a-service implementation. The service can be found at: https://research-software-directory.org
docker composeV2 (see the documentation of Docker Compose) locally.
yarnto automate the configuration and installation process.
.envfile at the root of the project and fill the secrets and passwords. Check if the secrets are correct. The
Makefilewill take care about creating an appropriate
make installto install all dependencies and build the docker images.
# Start the containers via the make file make start # OR directly use docker compose docker compose up
# Stop all services via the makefile make stop # OR directly use docker compose docker compose down
You can run frontend in development mode as docker a service (called frontend-dev) that enables hot reloading. By default this frontend-dev service will not be started automatically. For more detailed instructions see frontend/README.md.
# Run frontend development using docker at http://localhost:3000 make frontend-docker # OR use docker compose directly docker compose up --scale frontend=0 --scale scrapers=0 --scale frontend-dev=1
It is possible to directly run the frontend too (without using a docker container). You must then have NodeJS installed, preferably v18.
# Build and install all dependencies. make install # Run the frontend and the documentation on localhost:3000 and localhost:3030 make dev # Stop all services with `docker compose down` make down
More information about building and data migration can be found in Getting started documentation.
The content of this repository is licensed under several licenses. We follow the REUSE specification to indicate which license applies to the files specifically. Here are some general hints:
For more details on the licenses, please have a look at the file headers or associated
*.license files. The terms of all used licenses are located in the LICENSES directory.
Helmholtz Federated IT Services