Merge #483

483: Provide a sample Dockerfile and instructions to build & run it r=curquiza a=shutupflanders

# Pull Request

## Related issue
N/A

## What does this PR do?
- Adds a sample Dockerfile
- Adds instructions on how to build and run the mini dashboard using docker

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Martin Brooksbank <[email protected]>

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:20-alpine
+
+WORKDIR /home/node/app
+
+RUN chown -R node:node /home/node/app
+
+USER node
+
+COPY package*.json ./
+
+COPY --chown=node:node . .
+RUN yarn install
+
+CMD ["yarn", "start"]

README.md

@@ -112,6 +112,15 @@ Storybook is a development environment for UI components. It allows you to brows
 yarn storybook
 ```
 
+## Docker
+
+You can also run the mini-dashboard with Docker.
+
+```bash
+docker build -t meilisearch-mini-dashboard .
+docker run -it -e REACT_APP_MEILI_SERVER_ADDRESS=http://localhost:7700 -p 3000:3000 meilisearch-mini-dashboard
+```
+
 ## Contributing
 
 If you want to contribute to this project, please make sure to read [the contributing guidelines](./CONTRIBUTING.md)