Skip to content
This repository has been archived by the owner on Jul 8, 2020. It is now read-only.
/ frontal Public archive

DISCONTINUED: Markdown powered presentation tool build on Electron / Node.js still WIP

License

Notifications You must be signed in to change notification settings

frntl/frontal

Repository files navigation

This will no longer be deveoloped. There are so many fancy solutions out there. Also I learned for myself that creating a rich and awesome presentation needs more then markup.

frontal

Commitizen friendly license Gitter Code Climate Test Coverage Issue Count

Markdown powered presentation tool build on Electron / Node.js


Grab a build from here. Be aware that this is a pre-release. There might be 🐛 🐉.




Installation & run

Init the project by running:

#install nodejs using homebrew 
brew install node
git clone [email protected]:frntl/frontal.git && cd frontal
# if you use nvm you can run
# nvm use
# if you are using mert you can run
# mert start
npm install
npm start

Development

To write nice ES2015 style we use babel. Therefore we need to watch the whole src/ and compile it to app. Run it like this in the root of the directory (additional files in the src folder will also be copied by babel into the app/ folder):

npm run watch

To write on the default theme scss you can run

npm run sassdefault

Installing Additional Modules

For packing the app we use the electron-builder package. Therefor we have two package.json files. If you want to add another module (currently - will be improved) you will need to:

# dont do this while the watch task is running!
cd app/
npm install [your-module] --save && cat package.json ../src/package.json

tests

To run the tests just do a

npm test

build

For buildung the distribution version we use the electron-builder package. To make this work we have two package.json files. One in the root for development (devDependencies) and one in the src/ folder for distribution. Run

npm run dist

for building the package


Related projects:

So why writing another app for this task? Well on the one hand it is for learning application development with electron. On the other hand we started this because all the other options did have one or the other thing that we didn't like. (And because we can)

About

DISCONTINUED: Markdown powered presentation tool build on Electron / Node.js still WIP

Resources

License

Stars

Watchers

Forks

Packages

No packages published