mirror
/
bazarr
mirror of https://github.com/morpheus65535/bazarr
1
0
Fork 0
Code Issues Releases Wiki Activity
bazarr/frontend
History
morpheus65535 bccded275c
Replaced peewee with sqlalchemy as ORM. This is a major change, please report related issues on Discord. 		2023-07-26 19:34:49 -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 no log: Improve dev tools 2022-09-21 05:40:02 +08:00
public/images no log: fix favicon 2022-09-28 06:27:52 -04:00
src Replaced peewee with sqlalchemy as ORM. This is a major change, please report related issues on Discord. 2023-07-26 19:34:49 -04:00
.env.development no log: Auto detect backend port and base_url during development 2022-03-17 12:01:22 +08: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 Replace Bootstrap with Mantine (#1795) 2022-05-31 23:49:04 +08: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
README.md no log: Auto detect backend port and base_url during development 2022-03-17 12:01:22 +08:00
index.html no log: fix favicon 2022-09-28 06:27:52 -04:00
package-lock.json Downgrade Axios to fix a settings saving issue. 2023-06-05 09:32:30 +08:00
package.json Downgrade Axios to fix a settings saving issue. 2023-06-05 09:32:30 +08:00
tsconfig.json no log: Setup unit tests for UI 2022-03-29 01:10:24 +08: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: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 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