bazarr/frontend/README.md

79 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2021-03-25 22:22:43 +08:00
# Bazarr Frontend
2021-06-24 13:35:46 +08:00
## Dependencies
2024-06-10 09:24:02 +08:00
- Either [Node.js](https://nodejs.org/) installed manually or using [Node Version Manager](https://github.com/nvm-sh/nvm)
- npm (included in Node.js)
2021-03-25 22:22:43 +08:00
2024-06-10 09:24:02 +08:00
> 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`.
2021-06-24 13:35:46 +08:00
## Getting Started
2021-06-24 13:35:46 +08:00
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`
2021-06-24 13:35:46 +08:00
```
$ cp .env.development .env.development.local
2021-06-24 13:35:46 +08:00
```
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
2021-06-24 13:35:46 +08:00
```
$ python3 ../bazarr.py
```
7. Run the web development tool
2021-06-24 13:35:46 +08:00
```
$ npm start
```
2021-03-25 22:22:43 +08:00
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.
2023-12-14 11:20:27 +08:00
Open `http://localhost:5173` to view it in the browser.
2021-03-25 22:22:43 +08:00
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.
2021-03-25 22:22:43 +08:00
### `npm run format`
2021-03-25 22:22:43 +08:00
Format code for all files in `frontend` folder
2021-06-24 13:35:46 +08:00
This command will be automatic triggered before any commits to git. Run manually if you modify `.prettierignore` or `.prettierrc`