/photon

Primary LanguageSvelteMIT LicenseMIT

photon

TODO

table of content

requirements

installation

there currently is no official compiled release so you still have to download and compile yourself.

download

download the repository (you can use $ npx degit m4rch-xyz/photon photon) and then open a console and execute npm install in the installed folder

run

for the frontent to properly work you also need the backend to be installed and running. for future releases we plan on adding those two together to one single downloading and installing process.

to compile the entire app to an executable simply navigate into the correct folder and run $ npm run build

to run the frontend via the command line run $ npm start to compile the svelte-files into valid javascript and then run the electron app.

to only compile svelte run $ npm run svelte-build and to only start the electron app run $ npm run electron-start.

and if you want to develop use $ npm run dev for livereload.

backend

our backend service is available on our other github repo

add custom modes

custom modes now have to be added to the backend of your application