BudLib web interface

A web based front end for the budlib-api

Dependencies

• Node version 16.13.1 or above

How to run on web browser

1. Clone the repository on your machine

2. Make sure that BudLib API is running and is accessible

3. Running the below command from the repository's root directory will get the react server running. You can launch your browser and visit the default URL http://localhost:3000

   $ npm install
   $ npm start

How to run on Electron app

1. Clone the repository on your machine

2. Make sure that BudLib API is running and is accessible

3. Create the build of the web application

   $ npm run build

4. Run the run electron packaging script depending on your OS

   $ npm run package-win         # for Windows
   $ npm run package-linux       # for Linux
   $ npm run package-mac         # for macOS

5. The above command will create a electron-build directory, containing the electron build of the web application. For example, when using Windows, you will find electron executable file created as electron-build/budlib-win32-x64/budlib.exe.

Contributors

• Bhavyai Gupta
• Mike Lee

Attribution

• Bootstrap theme by Start BootStrap
• Icons and logo from Smashicons
• Dashboard images from Iconscout