aboutsummaryrefslogtreecommitdiffhomepage
path: root/frontend/README.md
diff options
context:
space:
mode:
authorLiang Yi <[email protected]>2021-03-25 22:22:43 +0800
committerGitHub <[email protected]>2021-03-25 10:22:43 -0400
commitf64719e4ad27df82d93f4eb2ea67c6fc81cf9d16 (patch)
treed518edda5b2bed6f8408de8e558b4ffb9a843bcb /frontend/README.md
parentfc9f7772b3b6364b9f92fc9bada9d7cabb8047e1 (diff)
downloadbazarr-f64719e4ad27df82d93f4eb2ea67c6fc81cf9d16.tar.gz
bazarr-f64719e4ad27df82d93f4eb2ea67c6fc81cf9d16.zip
Refactored Web UI using React
Diffstat (limited to 'frontend/README.md')
-rw-r--r--frontend/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/frontend/README.md b/frontend/README.md
new file mode 100644
index 000000000..b4333c0cd
--- /dev/null
+++ b/frontend/README.md
@@ -0,0 +1,30 @@
+# Bazarr Frontend
+
+## How to Run
+
+1. Duplicate `.env` file and rename to `.env.local`
+2. Fill any variable that defined in `.env.local`
+3. Run Bazarr backend (Backend must listening on `http://localhost:6767`)
+4. Start frontend by running `npm start`
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.
+Open `http://localhost:3000` to view it in the browser.
+
+The page will reload if you make edits.
+You will also see any lint errors in the console.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.
+
+### `npm run lint`
+
+Format code for all files in `frontend` folder
+
+This command will automatic trigger when you commit codes to git. Run manually if you modify `.prettierignore` or `.prettierrc`