https://github.com/ds-wizard/guide-screenshots
https://github.com/ds-wizard/guide-screenshots
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ds-wizard/guide-screenshots
- Owner: ds-wizard
- License: apache-2.0
- Created: 2023-01-04T17:20:42.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-07-01T09:19:53.000Z (12 months ago)
- Last Synced: 2025-07-26T15:50:09.892Z (11 months ago)
- Language: JavaScript
- Size: 114 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guide Screenshots
A repository for generating screenshots for the [DSW User Guide](https://github.com/ds-wizard/guide/tree/develop).
## Usage
### Install Requirements
Use node 18 and install all the dependencies:
```
$ make install
```
### Setup Environment
Create a new file `cypress.env.js` in the project root and fill in the URLs and user accounts of the instance used for taking screenshots, as well as some instance details to be filled.
```js
module.exports = {
url: "...",
apiUrl: "...",
adminUsername: "...",
adminPassword: "...",
dataStewardUsername: "...",
dataStewardPassword: "...",
researcherUsername: "...",
researcherPassword: "...",
appTitle: 'DS Wizard',
appTitleShort: 'DS Wizard',
primaryColor: '#E95420',
illustrationsColor: '#E95420',
logoFixture: 'logo.svg',
}
```
Logo should be placed in `cypress/fixtures/logo` folder. If the `logoFixture` property is not set, the default logo will be used.
Create `.env` in the project root and fill in path to DSW User Guide locally:
```
GUIDE_PATH=/path/to/ds-wizard/guide
```
### Create Scenarios for Screenshots
Use Cypress to create scenarios for taking screenshots. When taking a screenshot, use the file name that corresponds to the path where the screenshot should be in the docs.
For example, this one:
```js
cy.screenshot('projects/detail/index/questionnaire')
```
Will eventually end up in `/path/to/ds-wizard/guide/docs/projects/detail/index/questionnaire.png`.
### Run Cypress to Generate the Screenshots
```
$ make screenshots
```
### Run Cypress to Generate the Screenshots of a Specific Part
For example `knowledge-model-editors.cy.js`
```
$ make screenshots.spec test=knowledge-model-editors
```
### Copy the Screenshots into the Guide
```
$ make copy
```
## License
This project is licensed under the Apache License v2.0 - see the
[LICENSE](LICENSE) file for more details.