updated the readme file with e2e testing instructions (902941e3) · Commits · OSL / code / org.etsi.osl.tmf.web

README.md

+39 −11

Original line number	Diff line number	Diff line
		@@ -23,15 +23,19 @@ All primary configuration files are located in the following directory:

		`./src/assets/config/`

		The configuration files for the end to end testing are located in the following directory:
		`./cypress/`

		### Default Configuration Files (Templates)

		The following files serve as templates for customizing the environment:

		\| Filename \| Purpose \| Description \|
		\|-------------------------------- \|----------- \|--------------------------------------------------------------------- \|
		\| `config.prod.default.json` \| API & Basic Info \| Contains core application information, environment variables, and essential API endpoint configurations for the production environment. \|
		\| `theming.default.scss` \| CSS Theming \| Defines the SCSS variables for the application's color palette \|
		\| `config.theming.default.json` \| HTML Configuration \| Contains configurations for static UI elements like the application Logo URL, Favicon path, and dynamic content for the Footer. \|
		\| Filename \| Purpose \| Description \| Location \|
		\|-------------------------------- \|----------- \|--------------------------------------------------------------------- \| -------------
		\| `config.prod.default.json` \| API & Basic Info \| Contains core application information, environment variables, and essential API endpoint configurations for the production environment. \| `./src/assets/config/`
		\| `theming.default.scss` \| CSS Theming \| Defines the SCSS variables for the application's color palette \| `./src/assets/config/`
		\| `config.theming.default.json` \| HTML Configuration \| Contains configurations for static UI elements like the application Logo URL, Favicon path, and dynamic content for the Footer. \| `./src/assets/config/`
		\| `default.env` \| E2E Testing \| Contains default environment variables required for running Cypress End-to-End tests. \| `./cypress/`



		@@ -44,11 +48,12 @@ Before running or building the project, you must create copies of the templa

		The resulting files required for initial setup are:

		\| Filename \| Status \| Purpose \|
		\|-------------------------------- \|----------- \|--------------------------------------------------------------------- \|
		\| `config.prod.json` \| Mandatory \| The application's main configuration. (Copy of `config.prod.default.json`) \|
		\| `theming.scss` \| Mandatory \| The primary SCSS theming file. (Copy of `theming.default.scss`) \|
		\| `config.theming.json` \| _Optional_ \| HTML configuration for branding. (Copy of `config.theming.default.json`) \|
		\| Filename \| Status \| Purpose \| Location
		\|-------------------------------- \|----------- \|--------------------------------------------------------------------- \| --------- \|
		\| `config.prod.json` \| Mandatory \| The application's main configuration. (Copy of `config.prod.default.json`) \| `./src/assets/config/`
		\| `theming.scss` \| Mandatory \| The primary SCSS theming file. (Copy of `theming.default.scss`) \| `./src/assets/config/`
		\| `config.theming.json` \| _Optional_ \| HTML configuration for branding. (Copy of `config.theming.default.json`) \| `./src/assets/config/`
		\| `.env` \| Mandatory (for testing) \| The active environment configuration for Cypress. (Copy/Rename of default.env) \| `./cypress/`



		@@ -112,3 +117,26 @@ ng build --configuration production
		### Output

		The compiled, production-ready assets will be generated in the `/dist` directory within the project root. This directory contains the static files ready for deployment on any web server.

		## Running Tests (Cypress)

		This project uses Cypress for End-to-End (E2E) testing.

		### Prerequisites
		Environment Variables: Ensure you have created the `.env` file in the `./cypress/` directory as specified in the Configuration Setup table above.

		### Interactive Mode (Test Runner)
		Use this mode for developing tests. It opens the Cypress Test Runner UI, allowing you to select and watch tests run in a real browser

		```
		npm run cy:open
		```
		1. Select E2E Testing.
		2. Choose your preferred browser (e.g. Chrome, Electron).
		3. Click on a spec file (e.g. auth.cy.ts) to run it.

		### Headless Mode
		Use this mode to run all tests in the terminal without opening a browser window.
		```
		npm run cy:run
		```
		No newline at end of file