Stirling-PDF/frontend

Getting Started with Create React App

This project was bootstrapped with Create React App.

Docker Setup

For Docker deployments and configuration, see the Docker README.

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 your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run 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 and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Tauri

In order to run Tauri, you first have to build the Java backend for Tauri to use.

macOS/Linux:

From the root of the repo, run:

./gradlew clean build
./scripts/build-tauri-jlink.sh

Windows

From the root of the repo, run:

gradlew clean build
scripts\build-tauri-jlink.bat

Testing the Bundled Runtime

Before building the full Tauri app, you can test the bundled runtime:

macOS/Linux:

./frontend/src-tauri/runtime/launch-stirling.sh

Windows:

frontend\src-tauri\runtime\launch-stirling.bat

This will start Stirling-PDF using the bundled JRE, accessible at http://localhost:8080

Dev

To run Tauri in development. Use the command in the frontend folder:

npm run tauri-dev

This will run the gradle runboot command and the tauri dev command concurrently, starting the app once both are stable.

Build

To build a deployment of the Tauri app. Use this command in the frontend folder:

npm run tauri-build

This will bundle the backend and frontend into one executable for each target. Targets can be set within the tauri.conf.json file.