UI toolkit for building desktop apps with Electron.
- Clone the repo with
git clone https://github.com/connors/photon.git - Read the docs to learn about the components and how to get your new application started
Take note that our master branch is our active, unstable development branch and that if you're looking to download a stable copy of the repo, check the tagged downloads.
Within the download you'll find the following directories and files, logically grouping common assets. You'll see something like this:
photon/
├── css/
│ ├── photon.css
├── fonts/
│ ├── photon-entypo.eot
│ ├── photon-entypo.svg
│ ├── photon-entypo.ttf
│ └── photon-entypo.woff
└── template-app/
├── js/
│ └── menu.js
├── app.js
├── index.html
└── package.json
We provide compiled CSS (photon.*). We also include the Entypo fonts and a template Electron application for you to quickly get started.
Photon's documentation is built with Jekyll and publicly hosted on GitHub Pages at http://photonkit.com. The docs may also be run locally.
- If necessary, install Jekyll (requires v2.5.x).
- Windows users: Read this unofficial guide to get Jekyll up and running without problems.
- Install the Ruby-based syntax highlighter, Rouge, with
gem install rouge. - From the root
/photondirectory, runjekyll servein the command line. - Open http://localhost:4000 in your browser, and boom!
Learn more about using Jekyll by reading its documentation.
Please file a GitHub issue to report a bug. When reporting a bug, be sure to follow the contributor guidelines.
- Install node dependencies:
npm install. - Open the example app:
npm start.
Modifying source Sass files? Open a second Terminal tab and run npm run build to kick off a build of the compiled photon.css.
For transparency into our release cycle and in striving to maintain backward compatibility, Photon is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible.
Releases will be numbered with the following format:
<major>.<minor>.<patch>
And constructed with the following guidelines:
- Breaking backward compatibility bumps the major while resetting minor and patch
- New additions without breaking backward compatibility bumps the minor while resetting the patch
- Bug fixes and misc changes bumps only the patch
For more information on SemVer, please visit http://semver.org/.
Connor Sears
Copyright @connors. Released under MIT.
