mirror of https://github.com/morpheus65535/bazarr.git synced 2024-09-20 07:25:58 +08:00

History

morpheus65535 d59e3e5bc4 no log: Bump braces from 3.0.2 to 3.0.3 in /frontend		2024-06-18 05:42:42 -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	Upgraded react-query to v5	2024-06-10 21:37:14 -04:00
public	Added Progressive Web App support	2024-02-28 19:43:16 -05:00
src	Reverted normal only (non-hi) option to languages profile. Will be properly reintroduced later.	2024-06-14 12:24:23 -04:00
.env.development	Changing from config.ini to config.yaml	2023-10-14 09:56:21 -04:00
.eslintrc.json	no log: Apply style linter (#2516 )	2024-06-07 20:49:40 -04:00
.gitignore	Replace Bootstrap with Mantine (#1795 )	2022-05-31 23:49:04 +08: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	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 braces from 3.0.2 to 3.0.3 in /frontend	2024-06-18 05:42:42 -04:00
package.json	no log: Bump braces from 3.0.2 to 3.0.3 in /frontend	2024-06-18 05:42:42 -04: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	Upgraded mantine to v7.x	2024-06-06 23:00:42 -04:00

README.md

Bazarr Frontend

Dependencies

Either Node.js installed manually or using Node Version Manager
npm (included in Node.js)

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

Clone or download this repository

$ git clone https://github.com/morpheus65535/bazarr.git
$ cd bazarr/frontend

Install build dependencies in the project directory
```
$ npm install
```
(Optional) Duplicate .env.development file and rename to .env.development.local
```
$ cp .env.development .env.development.local
```
(Optional) Update your backend server's API key in .env.development.local
```
# API key of your backend
VITE_API_KEY="YOUR_SERVER_API_KEY"
```

(Optional) Change the address of your backend server

# Address of your backend
VITE_PROXY_URL=http://localhost:6767

Run Bazarr backend
```
$ python3 ../bazarr.py
```
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