Skip to content

Commit c8ba4ed

Browse files
committed
Add BUILD.md
1 parent dc8382a commit c8ba4ed

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

BUILD.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Building From Source
2+
3+
This repository contains a hot-reloading sandbox for developing the `@upload-io/react-uploader` NPM package.
4+
5+
## Prerequisites
6+
7+
`node` and `npm` are required — we actively support the following versions:
8+
9+
| Package | Version |
10+
| ------- | -------- |
11+
| Node | v18.12.1 |
12+
| NPM | v8.19.2 |
13+
14+
## How To Build & Run
15+
16+
### 1. Clone
17+
18+
```shell
19+
git clone git@github.com:upload-io/react-uploader.git
20+
cd react-uploader
21+
```
22+
23+
### 2. Setup Environment
24+
25+
```
26+
export NODE_OPTIONS=--openssl-legacy-provider
27+
```
28+
29+
### 3. Install Dependencies
30+
31+
```shell
32+
npm install
33+
```
34+
35+
### 4. Run The Tests
36+
37+
```shell
38+
npm test
39+
```
40+
41+
Note: there is no hot-reloading demo for `react-uploader`. Please see the `uploader` repository instead.

0 commit comments

Comments
 (0)