mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +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

2023-05-27 07:03:28 -04:00

1.3 KiB

Raw Blame History

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:

Comment out the portion pointing at the already built image
```
image: chatgptclone/app:0.3.3
```

Uncomment the portion pointing at the local source code

# image: node-api
# build:
#   context: .
#   target: node-api

Build your local source code for the node-api target

docker build `
  --target=node-api `
  -t node-api `
  .

Docker-compose up
```
docker-compose up
```

Option 2: Run the app by installing on your machine

Install the prerequisites on your machine. See section above.
Run the app on your machine. See section above.

Run the tests

Install the global dependencies

npm ci
npx playwright install --with-deps

Run tests
```
npx playwright test
```

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

1.3 KiB Raw Blame History