Skip to content

Commit 6536f73

Browse files
andrew-codesgithub-actions[bot]
authored andcommitted
[skip ci] docs: automated update to docs
skip-checks: true
1 parent 681f40d commit 6536f73

31 files changed

+13
-11
lines changed

docs/README.md

100755100644
File mode changed.

docs/documents/CONTRIBUTING.md

100755100644
File mode changed.

docs/documents/SECURITY.md

100755100644
File mode changed.

docs/documents/api/data-model.md

100755100644
File mode changed.

docs/documents/api/mqtt.md

100755100644
File mode changed.

docs/documents/contributing/conventions.md

100755100644
File mode changed.

docs/documents/contributing/development-environment/codespaces.md

100755100644
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ xhost + $IP
5252
1. [Fork the playnite-web repo](https://github.com/andrew-codes/playnite-web/fork)
5353
2. Start a code space and open in vscode.
5454
3. Run `yarn`
55-
4. Run `yarn run start`
55+
4. Run `yarn nx run playnite-web-app:start`
5656
5. In vscode, forward port 3000. This can be found in same pane as the terminal.
5757
6. Open [http://localhost:3000](http://localhost:3000).
5858
7. Continue to see [commands](./index.md#running-playnite-web) for additional commands.
@@ -61,4 +61,4 @@ xhost + $IP
6161

6262
1. Open terminal on local machine.
6363
2. Connect to code space via gh CLI and forward x11 via `gh cs ssh -- -XY` and then choose your code space.
64-
3. You can now run `yarn run test/components` and `yarn run test/e2e` in this terminal.
64+
3. You can now run `yarn nx run playnite-web-app:test/components` and `yarn nx run playnite-web-app:test/e2e` in this terminal.

docs/documents/contributing/development-environment/dev-container.md

100755100644
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ xhost + $IP
5656
3. Ensure docker is running.
5757
4. Open the command palette, type/search for comand `Dev Containers: Rebuild and Reopen container`. Allow the container to be built and started.
5858
5. Once the dev container is running and connected to vscode, run `yarn` in its terminal.
59-
6. Run `yarn run start`
59+
6. Run `yarn nx run playnite-web-app:start`
6060
7. In vscode, forward port 3000. This is likely done automatically or can be done with the `Forward Port` from the command palette.
6161
8. Open [http://localhost:3000](http://localhost:3000).
6262
9. Continue to see [commands](./index.md#running-playnite-web) for additional commands.

docs/documents/contributing/development-environment/index.md

100755100644
Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@ There are a few options for running Playnite Web for local development. Choose a
2121

2222
## Running Playnite Web
2323

24-
| Application | Command | Notes |
25-
| :--------------- | :-------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26-
| Playnite Web App | `yarn run start` | Run Playnite Web application locally. Navigate to [http://localhost:3000](http://localhost:3000) in a browser. Environment variables are pulled from `./apps/playnite-web/local.env`. |
27-
| Playnite Web App | `yarn run test/components` | Run component tests for development. |
28-
| Playnite Web App | `yarn run test/components/update` | Run component tests with intention to update a baseline screenshot. |
29-
| Playnite Web App | `yarn yarn run test/e2e` | Run end-to-end (e2e) tests for development (including visual regression capabilities). A consistent database restored along with consistent game assets. This ensures a reliable data set to test against. |
30-
| Playnite Web App | `yarn yarn run test/e2e/update` | Run end-to-end (e2e) tests with intention to update a baseline screenshot. |
24+
| Application | Command | Notes |
25+
| :--------------- | :----------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26+
| Playnite Web App | `yarn nx run playnite-web:start` | Run Playnite Web application locally. Navigate to [http://localhost:3000](http://localhost:3000) in a browser. Environment variables are pulled from `./apps/playnite-web/local.env`. |
27+
| Playnite Web App | `yarn nx run playnite-web:test/components` | Run component tests for development. |
28+
| Playnite Web App | `yarn nx run playnite-web:test/components/update` | Run component tests with intention to update a baseline screenshot. |
29+
| Playnite Web App | `yarn nx run playnite-web:test/components/update $GLOB_FILE_MATCH` | Run component tests with intention to update baseline screenshots. Runs only tests matching glob CLI parameter; e.g. `yarn nx run playnite-web:test/components/update FilterForm*` |
30+
| Playnite Web App | `yarn nx run playnite-web-app:test/e2e` | Run end-to-end (e2e) tests for development (including visual regression capabilities). A consistent database restored along with consistent game assets. This ensures a reliable data set to test against. |
31+
| Playnite Web App | `yarn nx run playnite-web-app:test/e2e/update` | Run end-to-end (e2e) tests with intention to update a baseline screenshot. |
32+
| Playnite Web App | `yarn nx run playnite-web-app:test/e2e/update $GLOB_FILE_MATCH` | Run end-to-end (e2e) tests with intention to update a baseline screenshot. Runs only tests matching glob CLI parameter' e.g. `yarn nx run playnite-web-app:test/e2e/update **/browse*` |
3133

3234
## Playnite Web Plugin Development
3335

docs/documents/contributing/development-environment/local-environment.md

100755100644
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Install the following software on your local development machine:
2727
3. Open the repo in vscode.
2828
4. Run `yarn`
2929
5. Run `yarn nx run devenv:prepare`. This is only required for the first time working with the codebase.
30-
6. Run `yarn run start` and navigate to [http://localhost:3000](http://localhost:3000)
30+
6. Run `yarn nx run playnite-web-app:start` and navigate to [http://localhost:3000](http://localhost:3000)
3131
- Note that MQTT and Mongo will be started via docker automatically.
3232
- Mongo will restore a default database if no database already exists (if there are no files in `.data/mongodb`).
3333
- Note MQTT currently starts with no username/password configured.

docs/documents/contributing/rfc.md

100755100644
File mode changed.

docs/documents/design/README.md

100755100644
File mode changed.

docs/documents/guides/setup.md

100755100644
File mode changed.

docs/types.entities/README.md

100755100644
File mode changed.

docs/types.entities/type-aliases/CompletionStatus.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Entity.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Game.md

100755100644
File mode changed.

docs/types.entities/type-aliases/GameAsset.md

100755100644
File mode changed.

docs/types.entities/type-aliases/GameAssetType.md

100755100644
File mode changed.

docs/types.entities/type-aliases/GameFeature.md

100755100644
File mode changed.

docs/types.entities/type-aliases/GameSource.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Genre.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Identifiable.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Platform.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Playlist.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Release.md

100755100644
File mode changed.

docs/types.entities/type-aliases/RunState.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Series.md

100755100644
File mode changed.

docs/types.entities/type-aliases/Tag.md

100755100644
File mode changed.

docs/types.entities/type-aliases/User.md

100755100644
File mode changed.

docs/types.entities/variables/runStates.md

100755100644
File mode changed.

0 commit comments

Comments
 (0)