mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-01-04 09:38:50 +01:00
update: "documents" folder to "docs" (#391)
* Rename .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md to .github/pull_request_template.md fix: Pull Request Template Location * documents -> docs * Update windows_install.md Fix: Docker hyperlink * Update linux_install.md Fix: Layout (step 6) * Rename docs/contributions/code_of_conduct.md to CODE_OF_CONDUCT.md fix: Code of Conduct location according to GitHub's Guide * Update CODE_OF_CONDUCT.md Update: Contact info * Update README.md Update: Code of Conduct hyperlink in TOC * Update CODE_OF_CONDUCT.md Update: Link to ReadMe * Update CONTRIBUTORS.md update: add new name to the list * Update and rename docs/contributions/contributor_guidelines.md to CONTRIBUTING.md fix: change location according to GitHub's standards * Delete CONTRIBUTORS.md delete: contributor.md from root (already present in readme) * Update SECURITY.md * Update CONTRIBUTING.md Update discord link to point to rules * Update README.md Update discord link to point to rules * Update README.md fix: ToC
This commit is contained in:
parent
f40a2f8ee8
commit
d437e4b8cd
26 changed files with 34 additions and 57 deletions
69
docs/contributions/testing.md
Normal file
69
docs/contributions/testing.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
# 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.
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/22865959/235321489-9be48fd6-77d4-4e21-97ad-0254e140b934.png">
|
||||
|
||||
##
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue