LibreChat/docs/contributions/testing.md
bsu3338 fdc5265f48
MkDocs for Material (#545)
* Create mkdocs.yaml

* Create mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update mkdocs.yml

* Update README.md

* Update coding_conventions.md

* Update documentation_guidelines.md

* Update testing.md

* Update heroku.md

* Update hetzner_ubuntu.md

* Update google_search.md

* Update introduction.md

* Update make_your_own.md

* Update stable_diffusion.md

* Update wolfram.md

* Update proxy.md

* Update user_auth_system.md

* Update bing_jailbreak_info.md

* Update breaking_changes.md

* Update multilingual_information.md

* Update project_origin.md

* Update tech_stack.md

* Update apis_and_tokens.md

* Update docker_install.md

* Update linux_install.md

* Update mac_install.md

* Update windows_install.md

* Update mkdocs.yml

* Update mkdocs.yml

* Update documentation_guidelines.md

* Add files via upload

* Create temp.txt

* Add files via upload

* Delete logo.png

* Create index.md

* Update mkdocs.yml

* Update mkdocs.yml

* Delete temp.txt

* Update README.md

* Update README.md

---------

Co-authored-by: Danny Avila <110412045+danny-avila@users.noreply.github.com>
2023-06-24 23:00:10 -04:00

1.2 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.