bazarr/frontend
morpheus65535 46a8bd2909 Merge remote-tracking branch 'origin/development' into development 2021-12-18 11:39:40 -05:00
..
.husky no log: Fix a protential issue which may crash the release pipeline 2021-09-01 00:36:39 +08:00
public no log: Move theme-color meta to Header.tsx 2021-08-22 13:35:43 +08:00
src Merge remote-tracking branch 'origin/development' into development 2021-12-18 11:39:40 -05:00
.env.development no log: Clean up package.json 2021-08-30 09:13:41 +08:00
.eslintrc.json no log: Clean up package.json 2021-08-30 09:13:41 +08:00
.gitignore no log: Update gitignore list 2021-08-29 23:17:53 +08:00
.prettierignore Refactored Web UI using React 2021-03-25 10:22:43 -04:00
.prettierrc Refactored Web UI using React 2021-03-25 10:22:43 -04:00
README.md no log: Clean up package.json 2021-08-30 09:13:41 +08:00
package-lock.json no log: Bump pretty-quick from 3.1.1 to 3.1.2 in /frontend (#1641) 2021-12-13 19:58:14 -05:00
package.json no log: Remove unused packages 2021-12-11 23:15:52 +08:00
tsconfig.json Update Redux Implementation with Redux-Toolkit 2021-08-14 20:59:08 +08:00

README.md

Bazarr Frontend

Dependencies

  • Node.js
  • npm (included in Node.js)

Getting Started

  1. Clone or download this repository

    $ git clone https://github.com/morpheus65535/bazarr.git
    $ cd bazarr/frontend
    
  2. Install build dependencies in the project directory

    $ npm install
    
  3. Duplicate .env.development file and rename to .env.local

    $ cp .env .env.local
    
  4. Update your backend server's API key in .env.local

    # API key of your backend
    REACT_APP_APIKEY="YOUR_SERVER_API_KEY"
    
  5. Change the address of your backend server (Optional)

    http://localhost:6767 will be used by default

    # Address of your backend
    REACT_APP_PROXY_URL=http://localhost:6767
    
  6. Run Bazarr backend

    $ python3 ../bazarr.py
    
  7. Run the web development tool

    $ 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 test

Run the Unit Test to validate app state.

Please ensure all tests are passed before uploading the code

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 be automatic triggered before any commits to git. Run manually if you modify .prettierignore or .prettierrc