npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

electron-angular-boilerplate

v1.5.0

Published

A basic electron app using AngularJS and Skeleton CSS with ES6 support

Downloads

230

Readme

Electron-Boilerplate

A template for Electron projects to build/publish Mac/Windows/Linux compatible applications

Build Status

Table of Contents:


  1. Installation
  2. The Stack
  3. Adding new views
  4. Adding/Managing Bower Resources
  5. Building the Desktop Application
  6. Testing
  7. FAQ

Installation:

For development, run:

./scripts/load_globals.sh
npm install
npm start

As for preparing the Windows/Mac/Linux apps for distribution. You will first need to run the npm install. Afterwards, run the following to build all the apps for all architectures and distributions:

# Requires GNU Make to be installed
make

The Stack:

The App Stack includes various tools and frameworks. Below is a list of those items and their intended purpose:

  • AngularJS: Client Side Web-App Stack
  • Bower: Managing CSS/JS dependencies (i.e. AngularJS)
  • Gulp: Build Automation for compiling Sass + other resources before Electron
  • Gnu-Make: Lower level build automation via the terminal (bash)
  • Jest: Testing framework for ES6/JS modules + code coverage support
  • JSPM: ES6 and Module importing support
  • Karma/Jasmine: Testing framework for AngularJS + code coverage support
  • Node.js: Running the Electron/Desktop Application
  • Sass: Enhanced Stylesheets
  • Skeleton CSS: Normalized + Simple CSS Grid framework
  • Travis: CI (Continous Integration) support
  • Wiredep: Injecting Bower dependencies into the HTML files

If you would like to suggest another tool or framework, please refer to the CONTRIBUTING.md before submitting an issue.

Adding new views

Thanks to the use of Gulp and Wiredep, it is recommended that all new views be written in the views directory as .html files in order to take advantage of the resource injection tool. The compiled views are then dumped into the same folder with all dependencies (even new ones) injected.

Adding/Managing Bower Resources

In order to add a new resource, simply install + save it using bower. Below is an example using jQuery

bower install --save jquery

And thats it. Since we are using Gulp + Wiredep, all bower dependencies will be included on pages supporting the Wiredep tags.

Building the Desktop Application

Since the app was built using Node.js, you only need to run the following command for development testing:

npm start

As for building the final Desktop Application. You can use any of the following make commands to build them:

  • Mac: make mac-64
  • Windows 32-Bit: make windows
  • Windows 64-Bit: make windows-64
  • Linux: make linux
  • Linux 64-bit: make linux-64

Alternatively, you can build all the apps at once by calling make apps

Testing

Tests are broken between two layers. All ES6 Modules/JS code should be tested using Jest. Alternatively, any testing for AngularJS content should be done using Karma/Jasmine. For more details on this, refer to the FAQ about Where to write tests.

FAQ:

  1. Where can I write my tests?

    All the ES6/Module tests are written in Jest. You can refer to the __tests__ folder for that. All test files for Jest should match against this file extension pattern *.jest.js. Alternatively, all AngularJS tests should be written using the following file extension pattern *.spec.js. These tests should be written within the b__tests__/app/ folder.