photon README

The project's README from github.com/connors/photon. As one markdown file: README.md.

Photon

Build Status

UI toolkit for building desktop apps with Electron.

Getting 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.

What's included

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.

Documentation

Photon's documentation is built with Jekyll and publicly hosted on GitHub Pages at http://photonkit.com. The docs may also be run locally.

Running documentation locally

  1. If necessary, install Jekyll (requires v2.5.x).
  1. Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
  2. From the root /photon directory, run jekyll serve in the command line.
  3. Open http://localhost:4000 in your browser, and boom!

Learn more about using Jekyll by reading its documentation.

Contributing

Please file a GitHub issue to report a bug. When reporting a bug, be sure to follow the contributor guidelines.

Development

  1. Install node dependencies: npm install.
  2. 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.

Versioning

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:

For more information on SemVer, please visit http://semver.org/.

Maintainers

Connor Sears

License

Copyright @connors. Released under MIT.

photon (connors/photon)

Searching Database…

10.1K ·GitHub
Photon
What is this?Photon is a UI toolkit for building desktop apps with Electron: you design your app's interface in plain HTML and CSS using its ready-made styles and components.
Is this a full framework, or just a stylesheet I drop into my project?It is a CSS UI kit rather than an app builder: the download ships compiled CSS (photon.css), the Entypo fonts, and a template Electron application to start from.
How do I get an app running with it?Clone the repo with git clone and read the docs to learn the components; the repo includes a template Electron app you can launch with npm start. For stable code, use the tagged downloads.
What do I need installed to work with it?Node.js with Electron for the bundled template app, since npm start runs it through electron; the toolkit itself is just CSS and fonts your app includes.
Anything to watch out for before I clone it?Yes: master is the active, unstable development branch, so grab a stable copy from the tagged downloads instead of building on master.
Is Photon free to use in my own apps?Yes, it is released under the MIT license, so you can use it freely in personal and commercial Electron apps.
What exactly comes in the Photon download?The compiled stylesheet (photon.css), the Entypo fonts, and a template Electron application to help you get your own app started quickly.
Where are the component docs hosted?The documentation is built with Jekyll and publicly hosted on GitHub Pages; the README sends you there to learn the components and get your new application started.
What are similar projects?materialize, mdb-ui-kit, uikit, bulma, weui, milligram, daisyui, Semantic-UI
Which topics is it in?css-framework, ui-kit, electron-app, design, electron, css, developers, html, ui, framework, desktop-app, frontend
Creator
connors
Size
3.1 MB
Stars
10.1K
Updated
CommitFeb 24
Age
11y
Commits · 90 Days