bazarr/frontend
2024-09-13 21:58:58 +09: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 Upgraded react-query to v5 2024-06-10 21:37:14 -04:00
public/images Fixed PWA not registered (#2566) 2024-07-05 22:37:01 +09:00
src Added support for Legendas.net provider 2024-09-13 08:44:19 -04:00
.env.development Changing from config.ini to config.yaml 2023-10-14 09:56:21 -04:00
.eslintrc.json no log: Eslint plugin updates (#2574) 2024-08-29 16:49:13 +09:00
.gitignore Fixed PWA not registered (#2566) 2024-07-05 22:37:01 +09:00
.nvmrc no log: Added node version lock 2024-06-09 21:24:02 -04:00
.prettierignore Add Unit Tests to UI (#2015) 2023-02-10 23:10:13 +08:00
.prettierrc Refactored Web UI using React 2021-03-25 10:22:43 -04:00
index.html Fixed PWA not registered (#2566) 2024-07-05 22:37:01 +09:00
package-lock.json no log: Bump @types/react in /frontend in the react group (#2653) 2024-09-13 21:58:58 +09:00
package.json no log: Bump @types/react in /frontend in the react group (#2653) 2024-09-13 21:58:58 +09:00
postcss.config.cjs Upgraded mantine to v7.x 2024-06-06 23:00:42 -04:00
README.md no log: Added node version lock 2024-06-09 21:24:02 -04:00
tsconfig.json no log: small format fix 2024-03-03 22:27:00 -05:00
vite.config.ts Fixed cached logged out index page 2024-07-12 09:55:55 +09:00

Bazarr Frontend

Dependencies

The recommended Node version to use and maintained is managed on the .nvmrc file. You can either install manually or use nvm install followed by nvm use.

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