Merge pull request #22 from mistralai/bam4d/fetch

Bam4d/fetch

.eslintrc.yml

@@ -2,6 +2,8 @@ env:
   browser: true
   es2021: true
 extends: google
+ignorePatterns: 
+  - examples/chat-react/
 parserOptions:
   ecmaVersion: latest
   sourceType: module

README.md

@@ -19,6 +19,21 @@ cd examples
 npm install .
 ```
 
+### API Key Setup
+
+Running the examples requires a Mistral AI API key.
+
+1. Get your own Mistral API Key: <https://docs.mistral.ai/#api-access>
+2. Set your Mistral API Key as an environment variable. You only need to do this once.
+
+```bash
+# set Mistral API Key (using zsh for example)
+$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv
+
+# reload the environment (or just quit and open a new terminal)
+$ source ~/.zshenv
+```
+
 You can then run the examples using node:
 
 ```bash

examples/chat-react/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

examples/chat-react/README.md

@@ -0,0 +1,32 @@
+# Mistral AI JS Client Web Demo
+
+A demo of the Mistral AI client being used in a React App.
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+```bash
+npm start
+```
+
+This will start a web-browser instance. 
+
+### API Key Setup
+
+Running the examples requires a Mistral AI API key.
+
+1. Get your own Mistral API Key: <https://docs.mistral.ai/#api-access>
+2. Set your Mistral API Key as an environment variable. You only need to do this once.
+
+```bash
+# set Mistral API Key (using zsh for example)
+$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv
+
+# reload the environment (or just quit and open a new terminal)
+$ source ~/.zshenv
+```