|
@@ -12,11 +12,11 @@ cd uppy
|
|
|
npm install
|
|
|
```
|
|
|
|
|
|
-Our website's examples section is also our playground, please read the [Local Previews](#Local-previews) section to get up and running.
|
|
|
+Our website’s examples section is also our playground, please read the [Local Previews](#Local-previews) section to get up and running.
|
|
|
|
|
|
### Requiring files
|
|
|
|
|
|
-* If we are `require()`ing a file from the same subpackage, we can freely use relative imports as long as the required file is under the `src` directory (e.g. to import `@uppy/dashboard/src/utils/hi.js` from `@uppy/dashboard/src/index.js`, use `require('./utils/hi.js')`).
|
|
|
+* If we are `require()`ing a file from the same subpackage, we can freely use relative imports as long as the required file is under the `src` directory (for example to import `@uppy/dashboard/src/utils/hi.js` from `@uppy/dashboard/src/index.js`, use `require('./utils/hi.js')`).
|
|
|
* But if we want to `require()` some file from another subpackage - we should use global @uppy requires, and they should always be in the form of `@uppy/:packageName/(lib instead of src)/(same path).js`
|
|
|
|
|
|
## Tests
|
|
@@ -60,7 +60,7 @@ You can run in several browsers by passing several `-b` flags:
|
|
|
npm run test:endtoend:local -- -b chrome -b firefox
|
|
|
```
|
|
|
|
|
|
-When trying to get a specific integration test to pass, it’s not that helpful to continuously run _all_ tests. You can use the `--suite` flag to run tests from a single `./test/endtoend` folder. For example, `--suite thumbnails` will only run the tests from `./test/endtoend/thumbnails`. It can also be joint with one or more `-b` flags.
|
|
|
+When trying to get a specific integration test to pass, it’s not that helpful to continuously run _all_ tests. You can use the `--suite` flag to run tests from a single `./test/endtoend` folder. For example, `--suite thumbnails` will only run the tests from `./test/endtoend/thumbnails`. It can also be used in conjunction with one or more `-b` flags.
|
|
|
|
|
|
```bash
|
|
|
npm run test:endtoend:local -- -b chrome --suite thumbnails
|
|
@@ -89,8 +89,8 @@ Run
|
|
|
ngrok http 3020
|
|
|
```
|
|
|
|
|
|
-Note the ngrok https base URL, e.g. `https://e0c7de09808d.ngrok.io` and
|
|
|
-append `/instagram/redirect` to it, e.g.:
|
|
|
+Note the ngrok https base URL, for example `https://e0c7de09808d.ngrok.io` and
|
|
|
+append `/instagram/redirect` to it, such as:
|
|
|
|
|
|
https://e0c7de09808d.ngrok.io/instagram/redirect
|
|
|
|
|
@@ -162,7 +162,7 @@ If you don’t have access to the transloadit.com source code ping @arturi or @g
|
|
|
|
|
|
We keep the [uppy.io](http://uppy.io) website in `./website` to keep docs and code in sync as we are still iterating at high velocity.
|
|
|
|
|
|
-The site is built with [Hexo](http://hexo.io/), and Travis automatically deploys this onto GitHub Pages (it overwrites the `gh-pages` branch with Hexo’s build at every change to `master`). The content is written in Markdown and located in `./website/src`. Feel free to fork & hack!
|
|
|
+The site is built with [Hexo](http://hexo.io/), and Travis automatically deploys this onto GitHub Pages (it overwrites the `gh-pages` branch with Hexo’s build at every change to `main`). The content is written in Markdown and located in `./website/src`. Feel free to fork & hack!
|
|
|
|
|
|
Even though bundled in this repo, the website is regarded as a separate project. As such, it has its own `package.json` and we aim to keep the surface where the two projects interface as small as possible. `./website/update.js` is called during website builds to inject the Uppy knowledge into the site.
|
|
|
|
|
@@ -190,7 +190,7 @@ The CSS standards followed in this project closely resemble those from [Medium
|
|
|
### Naming conventions
|
|
|
|
|
|
This project uses naming conventions adopted from the SUIT CSS framework.
|
|
|
-[Read about them here](https://github.com/suitcss/suit/blob/master/doc/naming-conventions.md).
|
|
|
+[Read about them here](https://github.com/suitcss/suit/blob/main/doc/naming-conventions.md).
|
|
|
|
|
|
To quickly summarize:
|
|
|
|
|
@@ -364,7 +364,7 @@ This data is used to generate Uppy’s website. Refer to [the section about runn
|
|
|
|
|
|
### Adding an example
|
|
|
|
|
|
-You can likely use whatever code generation tool for your framework (ex. `create-react-app`) to create this example. Make sure you add the same version of `@uppy/core` to this as your peer dependency required, or you may run into strange issues. Try to include all the components are some of their functionality. [The React example](https://github.com/transloadit/uppy/blob/master/examples/react-example/App.js) is a great... well example of how to do this well.
|
|
|
+You can likely use whatever code generation tool for your framework (ex. `create-react-app`) to create this example. Make sure you add the same version of `@uppy/core` to this as your peer dependency required, or you may run into strange issues. Try to include all the components are some of their functionality. [The React example](https://github.com/transloadit/uppy/blob/main/examples/react-example/App.js) is a great... well example of how to do this well.
|
|
|
|
|
|
### Integrating the build system
|
|
|
|