Skip to content

ShokoAnime/Shoko-WebUI

Repository files navigation

Available Scripts

In the project directory, you can run:

pnpm 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.

pnpm build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified.

pnpm lint

Check source code with eslint and stylelint. Run this before you submit a PR.

First time setup

If your Shoko server is not running on the same machine as you are developing you can adjust proxy settings.

Copy proxy.config.default.js to proxy.config.js and adjust as needed.

If you need to adjust Webpack settings copy webpack.config.default.js to webpack.config.js and adjust as needed.

Contributing

We are always accepting help, and there are a million little things that always need done. Hop on our discord and talk to us. Communication is important in any team. No offesnse, but it's difficult to help anyone that shows up out of nowhere, opens 3 issues, then creates a PR without even talking to us. We have a wealth of experience. Let us help you...preferably before the ADHD takes over, you hyperfixate, and you come up with a fantastic solution to problem that isn't at all what you expected. Support is also best found in the discord, in case you read this far.

Alt