mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-01-06 10:38:50 +01:00
🧹📚 docs: refactor and clean up (#1392)
* 📑 update mkdocs * rename docker override file and add to gitignore * update .env.example - GOOGLE_MODELS * update index.md * doc refactor: split installation and configuration in two sub-folders * doc update: installation guides * doc update: configuration guides * doc: new docker override guide * doc: new beginner's guide for contributions - Thanks @Berry-13 * doc: update documentation_guidelines.md * doc: update testing.md * doc: update deployment guides * doc: update /dev readme * doc: update general_info * doc: add 0 value to doc weight * doc: add index.md to every doc folders * doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md * doc: update toc so they display properly on the right had side in mkdocs * doc: update pandoranext.md * doc: index logging_system.md * doc: update readme.md * doc: update litellm.md * doc: update ./dev/readme.md * doc:🔖 new presets.md * doc: minor corrections * doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs * doc update: add screenshots to presets.md * doc update: add screenshots to - OpenID with AWS Cognito * doc update: BingAI cookie instruction * doc update: discord auth * doc update: facebook auth * doc: corrections to user_auth_system.md * doc update: github auth * doc update: google auth * doc update: auth clean up * doc organization: installation * doc organization: configuration * doc organization: features+plugins & update:plugins screenshots * doc organization: deploymend + general_info & update: tech_stack.md * doc organization: contributions * doc: minor fixes * doc: minor fixes
This commit is contained in:
parent
5c27fa304a
commit
51050cc4d3
66 changed files with 1617 additions and 869 deletions
|
|
@ -1,60 +1,22 @@
|
|||
---
|
||||
title: 🧪 Testing During Development
|
||||
weight: -6
|
||||
---
|
||||
|
||||
# Locally test the app during development
|
||||
|
||||
### Run the app
|
||||
## WIP
|
||||
|
||||
#### Option 1: Run the app using Docker
|
||||
## Run the tests
|
||||
|
||||
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
|
||||
#### 1. Install the global dependencies
|
||||
|
||||
```shell
|
||||
npm ci
|
||||
npx playwright install --with-deps
|
||||
```
|
||||
|
||||
2. Run tests
|
||||
#### 2. Run tests
|
||||
|
||||
```shell
|
||||
npx playwright test
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue