LibreChat/docs/dev/README.md

# Dev
This directory contains files used for developer work

### Dockerfile-app: 
- used to build the DockerHub image
### eslintrc-stripped.js:
- alternate linting rules, used in development
### meilisearch.yml: 
- Dockerfile for building meilisearch image independently from project
### single-compose.yml: 
- Dockerfile for building app image without meilisearch and mongodb services
  - This is useful for deploying on Google, Azure, etc., as a single, leaner container.
- From root dir of the project, run `docker-compose -f ./docs/dev/single-compose.yml up --build`
  - When you don't need to build, run `docker-compose -f ./docs/dev/single-compose.yml up`
- This requires you use a MongoDB Atlas connection string for the `MONGO_URI` env var
  - A URI string to a mongodb service accessible to your container is also possible.
  - Remote Meilisearch may also be possible in the same manner, but is not tested.
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			`# Dev`
			`This directory contains files used for developer work`
Cleanup root dir, move dev-related files into /documents/ (#347) * chore: cleanup root dir and move extraneous dev related files to documents/dev * chore: cleanup root dir and move extraneous dev related files to documents/dev 2023-05-21 08:56:06 -04: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			`### Dockerfile-app:`
			`- used to build the DockerHub image`
			`### eslintrc-stripped.js:`
			`- alternate linting rules, used in development`
			`### meilisearch.yml:`
docs(dev): update README.md with instructions for using single-compose.yml (#676) feat(single-compose.yml): add single-compose.yml for building leaner app container without meilisearch and mongodb services - This is useful for deploying on Google, Azure, etc., as a single, leaner container. - Instructions for running the container are added to the README.md file. - The container requires a MongoDB Atlas connection string for the `MONGO_URI` environment variable. - Remote Meilisearch may also be possible, but is not tested. 2023-07-21 17:11:05 -07:00			`- Dockerfile for building meilisearch image independently from project`
			`### single-compose.yml:`
			`- Dockerfile for building app image without meilisearch and mongodb services`
			`- This is useful for deploying on Google, Azure, etc., as a single, leaner container.`
			- From root dir of the project, run `docker-compose -f ./docs/dev/single-compose.yml up --build`
			- When you don't need to build, run `docker-compose -f ./docs/dev/single-compose.yml up`
			- This requires you use a MongoDB Atlas connection string for the `MONGO_URI` env var
			`- A URI string to a mongodb service accessible to your container is also possible.`
			`- Remote Meilisearch may also be possible in the same manner, but is not tested.`