mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00

Docs: updates & enhancements for MKDocs (#555 )

* Update documents for mkdocs compatibility

* documents update

* documents update

* Update README.md

* Update README.md

add link to "https://docs.librechat.ai" on the logo

* document updates

* docs - badge updates

* docs - badge updates

* docs - badge updates

* Update docker_install.md

* Update .env.example

update default MONGO_URI to port 27018 so local install can communicate with the docker db

* Update windows_install.md

fix typo

2023-07-01 20:11:37 -04:00

1.2 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.2 KiB Raw Blame History