You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bazarr/frontend
Anderson Shindy Oki f424c21628
no log: Remove item overview fallback image poster
4 months ago
..
.husky no log: Add pattern parameter to the pretty-quick hook to limit the effective scope 2 years ago
config Upgraded react-query to v5 6 months ago
public/images Fixed PWA not registered (#2566) 5 months ago
src no log: Remove item overview fallback image poster 4 months ago
.env.development Changing from config.ini to config.yaml 1 year ago
.eslintrc.json no log: Apply style linter (#2516) 6 months ago
.gitignore Fixed PWA not registered (#2566) 5 months ago
.nvmrc no log: Added node version lock 6 months ago
.prettierignore Add Unit Tests to UI (#2015) 2 years ago
.prettierrc Refactored Web UI using React 4 years ago
README.md no log: Added node version lock 6 months ago
index.html Fixed PWA not registered (#2566) 5 months ago
package-lock.json no log: Bump the mantine group in /frontend with 6 updates (#2608) 4 months ago
package.json no log: Bump the mantine group in /frontend with 6 updates (#2608) 4 months ago
postcss.config.cjs Upgraded mantine to v7.x 6 months ago
tsconfig.json no log: small format fix 9 months ago
vite.config.ts Fixed cached logged out index page 4 months ago

README.md

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