LibreChat/docs/contributions/testing.md
Fuegovic 69d192bac3
Docs: assets clean up (#598)
* Update ngrok.md

* Update linode.md

* Update cloudflare.md

* Update testing.md

* Update google_search.md

* Update introduction.md

* Update stable_diffusion.md

* Update wolfram.md

* docs: assets clean up
2023-07-06 17:41:22 -04:00

67 lines
1.2 KiB
Markdown

# Locally test the app during development
### Run the app
#### Option 1: Run the app using Docker
For reproducibility and ease of use, you can use
the provided docker-compose file:
1. Comment out the portion pointing at the already built image
```yaml
image: chatgptclone/app:0.3.3
```
2. Uncomment the portion pointing at the local source code
```yaml
# image: node-api
# build:
# context: .
# target: node-api
```
3. Build your local source code for the `node-api` target
```shell
docker build `
--target=node-api `
-t node-api `
.
```
4. Docker-compose up
```shell
docker-compose up
```
#### Option 2: Run the app by installing on your machine
1. Install the prerequisites on your machine.
See [section above](#install-the-prerequisites-on-your-machine).
2. Run the app on your machine.
See [section above](#run-the-app).
### Run the tests
1. Install the global dependencies
```shell
npm ci
npx playwright install --with-deps
```
2. Run tests
```shell
npx playwright test
```
If everything goes well, you should see a `passed` message.
![testing-1](https://github.com/danny-avila/LibreChat/assets/32828263/35b5c6a8-5c76-4e76-8ad9-2b1977eabc2a)