Skip to content
This repository has been archived by the owner on Oct 26, 2019. It is now read-only.

Project Structure

Alexandru Rosianu edited this page Jul 15, 2015 · 1 revision
Path Description
build/ This is where the Electron framework, the compiled source code and the processed resources are moved to create the app.
dist/ Here you'll find the installers/packages after you run a pack: task.
cache/ Downloaded zip files of Electron releases are placed here.
docs/ Just some images. Use this wiki. I also recommend reading Electron's documentation.
resources/ Icons and config files used to create the installers/packages.
src/ The sweet things. HTML pages, scripts, stylesheets, modules and everything your app needs.
tasks/ The superheroes – the Gulp tasks that download, build, pack and do everything you need.
.babelrc Config file for the Babel transpiler.
.env-example You should have these variables in your environment for various tasks.
.eslintignore, .eslintrc Useful if you use the linter-eslint plugin for Atom.
appveyor.yml This file is used by AppVeyor to know how to build the Windows releases.
CHANGELOG.md Write here your changes after each release. If you want to, of course.
design.sketch The assets I designed for SuperKit. You can use it as a template to create your own.
gulpfile.coffee Just an entry point to tell Gulp where to find the tasks.
package.json Dependencies and stuff. Replace the names and URLs with your own.
Clone this wiki locally