فهرست منبع

examples: mention that you need to install & bootstrap

Renée Kooi 5 سال پیش
والد
کامیت
513ba53c37

+ 9 - 2
examples/aws-companion/readme.md

@@ -5,9 +5,16 @@ Files are uploaded to a randomly named directory inside the `whatever/` director
 
 ## Run it
 
-First set up the `COMPANION_AWS_KEY`, `COMPANION_AWS_SECRET`, `COMPANION_AWS_REGION`, and `COMPANION_AWS_BUCKET` environment variables for @uppy/companion.
+To run this example, make sure you've correctly installed the root repository:
 
-Move into this directory, then:
+```bash
+npm install
+npm run bootstrap
+```
+
+Then, set up the `COMPANION_AWS_KEY`, `COMPANION_AWS_SECRET`, `COMPANION_AWS_REGION`, and `COMPANION_AWS_BUCKET` environment variables for @uppy/companion.
+
+Then, navigate to this directory and run:
 
 ```bash
 npm install

+ 7 - 0
examples/aws-presigned-url/readme.md

@@ -4,6 +4,13 @@ This example uses a server-side PHP endpoint to sign uploads to S3.
 
 ## Running It
 
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+```
+
 This example uses the AWS PHP SDK.
 To install it, [get composer](https://getcomposer.org) and run `composer update` in this folder.
 

+ 7 - 0
examples/custom-provider/readme.md

@@ -5,6 +5,13 @@ This serves as an illustration on how integrating custom providers would work
 
 ## Run it
 
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+```
+
 Move into this directory, then:
 
 ```bash

+ 8 - 1
examples/digitalocean-spaces/readme.md

@@ -2,7 +2,14 @@
 
 This example uses Uppy to upload files to a DigitolOcean Space. DigitalOcean Spaces has an identical API to S3, so we can use the [AwsS3](https://uppy.io/docs/aws-s3) plugin. We use @uppy/companion with a [custom `endpoint` configuration](./server.js#L32-L33) that points to DigitalOcean.
 
-To try this example, first run:
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+```
+
+Then navigate to this directory, and run:
 
 ```bash
 npm install

+ 7 - 0
examples/multiple-instances/readme.md

@@ -5,6 +5,13 @@ It has two instances on the same page, side-by-side, but with different `id`s so
 
 ## Run it
 
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+```
+
 Move into this directory, then:
 
 ```bash

+ 7 - 1
examples/node-xhr/readme.md

@@ -4,7 +4,13 @@ This example uses Node server and `@uppy/xhr-upload` to upload files to the loca
 
 ## Run it
 
-First run `npm install && npm run bootstrap && npm run build` in the root folder of the uppy project.
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+npm run build
+```
 
 Then move into this directory (`examples/php-xhr`), and:
 

+ 7 - 1
examples/php-xhr/readme.md

@@ -4,7 +4,13 @@ This example uses PHP server and `@uppy/xhr-upload` to upload files to the local
 
 ## Run it
 
-First run `npm install && npm run bootstrap && npm run build` in the root folder of the uppy project.
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+npm run build
+```
 
 Then move into this directory (`examples/php-xhr`), and:
 

+ 7 - 1
examples/python-xhr/readme.md

@@ -4,7 +4,13 @@ This example uses a Python Flask server and `@uppy/xhr-upload` to upload files t
 
 ## Run it
 
-First run `npm install && npm run bootstrap && npm run build` in the root folder of the uppy project.
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+npm run build
+```
 
 Then move into this directory (`examples/python-xhr`), and:
 

+ 10 - 0
examples/react-native-expo/readme.md

@@ -6,6 +6,16 @@
 
 ## Run it
 
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+npm run build
+```
+
+Then navigate to this directory and run it:
+
 ```bash
 cd examples/react-native-expo
 npm install

+ 7 - 0
examples/redux/readme.md

@@ -8,6 +8,13 @@ This example supports the [Redux Devtools extension](https://github.com/zalmoxis
 
 ## Run it
 
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+```
+
 Move into this directory, then:
 
 ```bash

+ 7 - 0
examples/transloadit/readme.md

@@ -4,6 +4,13 @@ This example shows all the different Robodog APIs in action on a single page.
 
 ## Run it
 
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+```
+
 Move into this directory, then:
 
 ```bash

+ 12 - 1
examples/uppy-with-companion/README.md

@@ -4,5 +4,16 @@ This is a simple, lean example that combines the usage of @uppy/companion and up
 
 ## Test it
 
-To test it, run `npm install` to install the required dependencies, and then run `npm start`
+To run this example, make sure you've correctly installed the root repository:
 
+```bash
+npm install
+npm run bootstrap
+```
+
+Then, navigate to this directory and run:
+
+```bash
+npm install
+npm start
+```

+ 7 - 0
examples/xhr-bundle/readme.md

@@ -6,6 +6,13 @@ This example uses Uppy with XHRUpload plugin in `bundle` mode. Bundle mode uploa
 
 ## Run it
 
+To run this example, make sure you've correctly installed the root repository:
+
+```bash
+npm install
+npm run bootstrap
+```
+
 Move into this directory, then:
 
 ```bash