Skip to content

Commit

Permalink
Version 0.3.2 - Electron big upgrade & fixes (#26)
Browse files Browse the repository at this point in the history
# Changes

## Security fixes

- Migrate from electron 9.4.0 to 26.3.0

## Other things

- Rewrite readme
- Upgrade widgetbot html embed script to latest (1.3.0)
- Upgrade transitive dependencies

## Developer things

- Add electron-builder as developer dependency
- Pin node version using volta
- Change app name from "liveapp-mvp" to "liveapp-rtd" in package.json
- Regenerate package-lock.json
  - It was a v1 lockfile, now is a v3 one
  - Upgrade transitive dependencies
  • Loading branch information
AntoineJT authored Oct 5, 2023
2 parents 1ed018f + a0f11f3 commit cb6aebc
Show file tree
Hide file tree
Showing 7 changed files with 2,490 additions and 480 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# LiveApp MVP 🔴
# Read the Docs' Live App 🔴

![LiveApp logo](resources/logo/logo-128x.png)

Expand All @@ -7,21 +7,19 @@ In other words, it is an *always on top* application, which allows to do some ot

**The primary purpose of this app is to be used while streaming live, on discord!**

## WARNING!

This application is **heavy**: because of ElectronJS which is basically a full browser, it weighs around 160MB. \
It has originally been made in less than an hour, to get **a quick MVP**.
*This application is heavy: because of ElectronJS which is basically a full browser, it weighs around 230MB.*

## How to use

You can download the latest release [here](https://github.com/readthedocs-fr/LiveApp-frontend/releases), unzip it with [7-zip](https://www.7-zip.org/) and run liveapp.exe
You can download the latest release from [here](https://github.com/readthedocs-fr/liveapp/releases).

## How to build

You can build it by using *electron-builder*. \
To install *electron-builder* just do `npm install -g electron-builder` which will install it globally. \
Then, in the `src/` folder, just do `electron-builder` and it will compile the application for your operating system. \
You then can found the build into the `src/dist/` folder.
- Install [volta](https://volta.sh/)
- Go to `src/` folder and install dependencies (`npm install`)
- Run command `npm run build`

You will now found the build into the `src/dist/` folder.

## License

Expand Down
2 changes: 1 addition & 1 deletion resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

Here are the sources of LiveApp resources.

### File formats
## File formats

- PDN: [Paint.NET project file](https://www.getpaint.net/index.html)
Loading

0 comments on commit cb6aebc

Please sign in to comment.