mirror of https://github.com/morpheus65535/bazarr
76 lines
1.4 KiB
Markdown
76 lines
1.4 KiB
Markdown
# Bazarr Frontend
|
|
|
|
## Dependencies
|
|
|
|
- [Node.js](https://nodejs.org/)
|
|
- 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`
|