photon

The fastest way to build beautiful Electron apps using simple HTML and CSS

Subscribe to updates I use photon


Statistics on photon

Number of watchers on Github 8143
Number of open issues 79
Average time to close an issue 23 days
Main language CSS
Average time to merge a PR 23 days
Open pull requests 26+
Closed pull requests 11+
Last commit about 1 year ago
Repo Created over 2 years ago
Repo Last Updated 2 months ago
Size 3.08 MB
Homepage photonkit.com
Organization / Authorconnors
Contributors6
Page Updated
Do you use photon? Leave a review!
View open issues (79)
View photon activity
View on github
Latest Open Source Launches
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating photon for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

Photon

Build Status

UI toolkit for building desktop apps with Electron.

Getting started

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

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).
  2. Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
  3. From the root /photon directory, run jekyll serve in the command line.
  4. 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:

  • 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/.

Maintainers

Connor Sears

License

Copyright @connors. Released under MIT.

photon open issues Ask a question     (View All Issues)
  • over 1 year how about adding fonts to 'dist' folder
  • almost 2 years Add support for vibrancy
  • almost 2 years Error: Cannot find module 'remote'
  • almost 2 years template app should include dependencies in package.json
  • almost 2 years Workable tab component?
  • almost 2 years Create a separate repository for css framework?
  • almost 2 years How to make the table row multiple lines instead of horizenal scroll
  • almost 2 years Components are only based on MacOS UI? What about Windows?
  • almost 2 years Starting template application - "Error: Cannot find module 'app'"
  • almost 2 years syntax not updated for Electron 1.0?
  • almost 2 years List - rendering issues
  • almost 2 years Create examples for forms?
  • almost 2 years bg-primary class does not work on a bootstrap table
  • almost 2 years btn-dropdown subm menu items HOW?
  • about 2 years Toolbar header not draggable
  • about 2 years web components?
  • about 2 years Slider Component for PhotonKit
  • about 2 years Too many global styles!
  • about 2 years Update Entypo in Photon
  • about 2 years Usability issue with tabs
  • about 2 years Typos in template-app package.json
  • about 2 years pane-sm and pane-mini have no borders
  • over 2 years Need vertical pane stacking
  • over 2 years Need the panes to be resizable
  • over 2 years Error in menu.js
  • over 2 years Resizable table columns
  • over 2 years [Feature requests] Adding a loading component
  • over 2 years Context-Menu
  • over 2 years Publish on npm?
  • over 2 years Mini Pop-Over
photon open pull requests (View All Pulls)
  • Update tabs.scss
  • Better :focus support for .list-group-item
  • Fix height nav-group-item
  • Add feature: icon-text pull-right
  • Fix .btn-group when there is only one .btn present
  • Added bower.json file
  • HTML5 Modals
  • Add support for a toolbar-input
  • fix height of button groups section on doc
  • Implement OS X Cmd+W to close windows, clicking dock icon to open windows
  • Marks derived files as binaries
  • Pane resizing and nested/vertical pane groups (fixes #91 and #92)
  • Inactive Tab Font Color (Fixes #96)
  • Update template-app to support Electron 1.1.1
  • Fixes for current electron version
  • fixed a typo
  • fix for Electron App
  • Modifies the call obsolete electron to a recent version
  • Added travis ci support for modern node versions
  • Fix typo "cooresponding" --> "corresponding"
  • Updated app.js to work with latest electron
  • Hovering over an icon shows it's name
  • fix sidebar display bug
  • Fixing icon colour on button variations
  • Prevent active button inside button group width change
  • New Release 1.0
photon questions on Stackoverflow (View All Questions)
  • Unity3d WEB GL build with photon network
  • How To use Matchmaking with Photon?
  • Lua indexing nil value when posting data to Particle (formerly Spark) Photon
  • Unity Photon network Instantiate scene object
  • Installing VMware Photon OS on ESXi 5.5 through CLI
  • How to spawn an object by instantiating its prefab via photon unity network - unity 3d
  • Format and display Time on Photon
  • Character rotation stuttering over network (using photon)
  • Photon Cloud Offline Mode Can't find Spawn Points
  • Photon Unity 3D SDK crashes when exporting to WebGL
  • error: 'null' was not declared in this scope when setting integer to 0 - photon/arduino C++
  • Photon Server Register Custom Types
  • Create a trigger in Google script that can call a function in an photon script to reset a variable
  • Photon Unity Networking (PUN) trying to keep track of players on each team
  • My Photon Variable is only owned by MasterClient on Unity
  • Photon vmware pros and cons
  • How to sent a sychronize a script over photon unity network
  • Photon Server & Unity (Multiplayer Game Client/Server) Syncing Data
  • Photon 2d game multiplayer lags
  • PhotonNetwork - Synchronizing a queue over the server into a photon room
  • Photon detecting if a player is already in that spawn position
  • Photon only spawn the player that joined the room last
  • Photon creates a new room for each player
  • Where to retrieve audio file? -- Arduino - Photon project
  • Express Routing Error when using Photon Webhooks on Parse.com
  • How to extract Photon Api json response using Json.Net
  • Photon Multiplayer, Both players create their own rooms
  • Unity Photon Multiplayer Networking Turnbased game
  • Photon Unity GetRoomList() is always empty
  • Inviting friends to join your game room in Photon Unity Networking
photon list of languages used
Other projects in CSS