LibreChat/documents/contributions/testing.md
Fuegovic e2dc994b63
update documentation structure (#220)
* documentation refactor

* Update README.md

* Delete README.MD.md

* Delete LOCAL_INSTALL.md

* Rename LICENSE.MD.md to LICENSE.MD

* Update LICENSE.md

* Delete LICENSE.MD

* Rename CONTRIBUTORS.MD.md to CONTRIBUTORS.md

* Rename CHANGELOG.MD.md to CHANGELOG.md

* new documents layout

* Update README.md

* Rename mac_install (1).md to mac_install.md

* Rename docker_install.md to docker_install.md

* Rename linux_install.md to linux_install.md

* Update and rename mac_install.md to mac_install.md

* Rename windows_install.md to windows_install.md

* Update docker_install.md

* Update linux_install.md

* Update mac_install.md

* Update windows_install.md

* Update windows_install.md

* Update linux_install.md

* Update tech_stack.md

* Update roadmap.md

* Update project_origin.md

* Update bing_jailbreak_info.md

* Update user_auth_system.md

* Update proxy.md

* Update google_search.md

* Update heroku.md

* Update testing.md

* Update pull_request_template.md

* Update documentation_guidelines.md

* Update contributor_guidelines.md

* Update code_of_conduct.md

* Update README.md

* Update README.md

* Update README.md

* Update roadmap.md

* Update tech_stack.md

* Update feature_request_template.md

* Update bug_report_template.md

* Update custom_issue_template.md

* Update README.md

fix redirect

* Update README.md

dynamic toc

* Update README.md

hide plugins section for now

* Update README.md

removed plugins from TOC

* Update README.md

* Update README.md

* Update documentation_guidelines.md

* Update documentation_guidelines.md

* Update documentation_guidelines.md

directives update

* Update README.md

update shortcut

* Update CHANGELOG.md

* Update roadmap.md

add public trello link

* Update linux_install.md
2023-05-09 13:47:14 -04:00

1.3 KiB

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

    image: chatgptclone/app:0.3.3
    
  2. Uncomment the portion pointing at the local source code

    # image: node-api
    # build:
    #   context: .
    #   target: node-api
    
  3. Build your local source code for the node-api target

    docker build `
      --target=node-api `
      -t node-api `
      .
    
  4. Docker-compose up

    docker-compose up
    

Option 2: Run the app by installing on your machine

  1. Install the prerequisites on your machine. See section above.

  2. Run the app on your machine. See section above.

Run the tests

  1. Install the global dependencies

    npm ci
    npx playwright install --with-deps
    
  2. Run tests

    npx playwright test
    

If everything goes well, you should see a passed message.

Go Back to ReadMe