# RSD-as-a-service  ## Our mission: To promote the visibility, impact and reuse of research software This repo contains the new RSD-as-a-service implementation. The service can be found at: https://research-software-directory.org ## Badges | [fair-software.nl](https://fair-software.nl/) recommendations | | | :-- | :-- | | (1/5) code repository | [](https://github.com/research-software-directory/RSD-as-a-service) | | (2/5) source code license | [](https://opensource.org/licenses/Apache-2.0) | |           images & docs licenses | [](https://creativecommons.org/licenses/by/4.0/) [](https://creativecommons.org/licenses/by-sa/3.0/) [](http://creativecommons.org/publicdomain/zero/1.0/) [](https://opensource.org/licenses/MIT) | | (3/5) community registry | [](https://research-software-directory.org/software/rsd-ng) | | (4/5) citation | [](https://zenodo.org/badge/latestdoi/413814951) | | (5/5) checklist | [](https://bestpractices.coreinfrastructure.org/projects/6336) | | overall | [](https://fair-software.eu) | | **Other best practices** |   | | Contributor covenant | [](CODE_OF_CONDUCT.md) | | Contribution guidelines | [](CONTRIBUTING.md) | | **Tests** |   | | Citation metadata consistency | [](https://github.com/research-software-directory/RSD-as-a-service/actions/workflows/cff_validate.yml) | | Frontend | [](https://github.com/research-software-directory/RSD-as-a-service/actions/workflows/frontend_tests.yml) [](https://sonarcloud.io/summary/overall?id=rsd-frontend) | | Backend | [](https://github.com/research-software-directory/RSD-as-a-service/actions/workflows/backend_tests.yml) | | Authentication | [](https://github.com/research-software-directory/RSD-as-a-service/actions/workflows/authentication_tests.yml) [](https://sonarcloud.io/summary/overall?id=nl.research-software%3Aauthentication) | | Scrapers | [](https://github.com/research-software-directory/RSD-as-a-service/actions/workflows/scrapers_tests.yml) [](https://sonarcloud.io/summary/overall?id=nl.research-software%3Ascrapers) | | End-to-end | [](https://github.com/research-software-directory/RSD-as-a-service/actions/workflows/e2e_tests_chrome.yml) | ## How to build and run the RSD ### Building from source code 1. Before installing the dependencies ensure that you have `docker` and `docker compose` V2 (see the [documentation of Docker Compose](https://docs.docker.com/compose/compose-v2/)) locally. 2. You will also need `make` to automate the configuration and installation process. 3. Set the required environment variables: Copy the file `.env.example` to `.env` file at the root of the project and fill the secrets and passwords. Check if the secrets are correct. The `Makefile` will take care about creating an appropriate `frontend/.env.local` from the `.env` file, needed only when developing the frontend. 4. Run `make install` to install all dependencies and build the docker images. ### Running the services ``` # Start the containers via the make file make start # OR directly use docker compose docker compose up ``` ### Stopping the services ``` # Stop all services via the makefile make stop # OR directly use docker compose docker compose down ``` ## Developing the RSD We discourage the use of Safari for developing the RSD. The reason is that it is not possible to sign in with Safari on localhost, because Safari handles [secure cookies differently](https://codedamn.com/news/web-development/safari-cookie-is-not-being-set) from other browsers. When you need DOIs to test out functionality involving mentions, some lists can be found at [pull request #808](https://github.com/research-software-directory/RSD-as-a-service/pull/808). For more details on developing the RSD, see the respective readmes in the varying directories. ### Developing the frontend 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](frontend/README.md). ``` # Run frontend development using docker at http://localhost:3000 make frontend-dev # OR use docker compose directly docker compose -f docker-compose.yml -f docker-compose.dev.yml up ``` It is possible to directly run the frontend too (without using a docker container). You must then have Node.js installed, see the `Dockerfile` in the frontend directory for the version in use. ``` # 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 ``` ## License The content of this repository is licensed under several licenses. We follow the [REUSE specification](https://reuse.software/) to indicate which license applies to the files specifically. Here are some general hints: - Source code is licensed under `Apache-2.0` - Documentation and most images are licensed under `CC BY-4.0` - Some files with trivial content, e.g. configuration files, are licensed under `CC0-1.0` 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](./LICENSES/) directory.