Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/albe-rosado/create-proton-app
No Configuration Starter Template for Proton Native Apps
https://github.com/albe-rosado/create-proton-app
Last synced: about 1 month ago
JSON representation
No Configuration Starter Template for Proton Native Apps
- Host: GitHub
- URL: https://github.com/albe-rosado/create-proton-app
- Owner: albe-rosado
- License: mit
- Created: 2018-02-24T15:48:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T15:34:25.000Z (over 2 years ago)
- Last Synced: 2024-10-25T18:52:50.774Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 65.4 KB
- Stars: 198
- Watchers: 6
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - create-proton-app - No Configuration Starter Template for Proton Native Apps (JavaScript)
README
🚨This project is not being maintained anymore.🚨
# Create Proton Native App
Create [Proton Native](https://proton-native.js.org/#/) apps with no build configuration. Works on Linux, MacOS and Windows.
## Requirements
Tested with Node.js v10 (LTS).
### Windows:
```
npm install --global --production windows-build-tools
```
### Linux:
Install these packages.
#### Debian Based (.deb)
```
libgtk-3-dev build-essential python2-dev
```
*Specifically `g++ make dpkg-dev` from `build-essential`.*
#### Red Hat Based (.rpm)
```
gtk3-devel gcc-c++ make rpm-build python2-devel
```
## Usage
```sh
# install the cli
npm install -g create-proton-app
# create your proton native app
create-proton-app my-app
# got to your project directory and have fun!
cd my-app
npm run start
```
It will create a directory called `my-app` inside the current folder.
Inside that directory, it will generate the initial project structure and install Proton Native dependencies:
```
my-app
├── node_modules
├── package.json
├── index.js
└── .babelrc
```
## Packaging
We use `electron-builder` to handle the packaging for your application. Produces bundles for Linux(appImages, snaps, deb, rpm, ...) and MacOs. Windows support is unstable.
```sh
# build your app
npm run build
# bundle it
npm run dist
```
Only a minimal build/packaging config is provided, as your application grows you should take a look to the [documentation](https://www.electron.build/).
## Contributing
We'd love to have your helping hand!
- If you like this tool and have an idea of how to improve it or want to add an additional feature, create an issue explaining your idea.
- Please, avoid using third party libraries for small/simple tasks, make sure we really need that library in our project, such a simple tool shouln't have lots of dependencies that at the same time have their own almost infinite dependency trees.
- If something doesn’t work, please [file an issue](https://github.com/albe-rosado/create-proton-app/issues/new).
- Be nice.
## License
- [MIT](https://opensource.org/licenses/MIT)