bazarr/frontend
Anderson Shindy Oki 397310eff5
no log: Fix husky installation (#2488)
2024-05-07 20:32:17 -04:00
..
.husky no log: Add pattern parameter to the pretty-quick hook to limit the effective scope 2022-08-29 21:33:22 +08:00
config Updated multiple Python modules (now in libs and custom_libs directories) and React libraries 2024-03-03 12:15:23 -05:00
public Added Progressive Web App support 2024-02-28 19:43:16 -05:00
src Improved cutoff options label. #2466 2024-04-24 22:34:42 -04:00
.env.development Changing from config.ini to config.yaml 2023-10-14 09:56:21 -04:00
.eslintrc.json no log: Add warning when not writing camelCase in frontend project. We should fix those later 2023-02-20 14:36:43 +08:00
.gitignore
.prettierignore Add Unit Tests to UI (#2015) 2023-02-10 23:10:13 +08:00
.prettierrc
README.md no log: fix dev server port 2023-12-13 22:20:27 -05:00
index.html Updated multiple Python modules (now in libs and custom_libs directories) and React libraries 2024-03-03 12:15:23 -05:00
package-lock.json no log: Bump recharts from 2.12.4 to 2.12.6 in /frontend (#2487) 2024-05-06 19:06:38 -04:00
package.json no log: Fix husky installation (#2488) 2024-05-07 20:32:17 -04:00
tsconfig.json no log: small format fix 2024-03-03 22:27:00 -05:00
vite.config.ts no log: Move setup file to src folder 2023-02-11 01:36:46 +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. (Optional) Duplicate .env.development file and rename to .env.development.local

    $ cp .env.development .env.development.local
    
  4. (Optional) Update your backend server's API key in .env.development.local

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

    # Address of your backend
    VITE_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:5173 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 in production mode and save to the build folder.

npm run format

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