kea - npm Package Compare versions

Comparing version 0.0.0 to 0.1.0

bin/kea.js

 #! /usr/bin/env node
-console.log("i'm a mountain parrot!")
 
+'use strict'
+
+var program = require('commander')
+var packageJson = require('../package.json')
+
+program
+  .version(packageJson.version)
+  .usage('<command>')
+  .command('new [project_name]', 'create a new project')
+  .parse(process.argv)
+
+if(!program.args.length) {
+  program.help()
+}

package.json

 {
   "name": "kea",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "bin": {
-    "kea": "bin/kea.js"
+    "kea": "bin/kea.js",
+    "kea-new": "bin/kea-new.js"
+  },
+  "dependencies": {
+    "commander": "^2.9.0"
   }
 }

README.md

@@ -1,2 +0,66 @@
-# kea
-smart js framework
+![Kea the mountain parrot](https://raw.githubusercontent.com/mariusandra/kea/master/kea-small.jpg)
+
+Kea is two things:
+
+1. A smart and cheeky mountain parrot from New Zealand
+2. An smart and cheeky architecture for writing modern web applications
+
+The `kea` architecture consists of the following pieces:
+
+* [react](https://github.com/facebook/react)
+* [react-router](https://github.com/reactjs/react-router)
+* [redux](https://github.com/reactjs/redux)
+* [redux-act](https://github.com/pauldijou/redux-act) (no need to duplicate your redux constants 5 times!)
+* [redux-saga](https://github.com/yelouafi/redux-saga) (write complex async logic sequentially)
+* [redux-form](https://github.com/erikras/redux-form) (forms made easy)
+* [reselect](https://github.com/reactjs/reselect) (separate data transformations from other logic)
+* [webpack](https://github.com/webpack/webpack)
+* several custom helpers to tie them all together
+
+It's written in the [JavaScript Stardard Style](https://github.com/feross/standard) and puts a strong emphasis on
+code clarity, reduced redundancy and stability.
+
+`kea` provides:
+* a modular scaffolding tool
+* an elegant code structure that just makes sense.
+* generators for the most common tasks
+* a guide to teach you how it all fits together
+
+Out of the box you get:
+* hot reloads while developing
+* code chunking for each scene, so only the important parts of the application are loaded
+* modular CSS, so you don't have to worry about namespaces
+
+Optional:
+* isomorphic javascript that renders both on the server (via [react_on_rails](https://github.com/shakacode/react_on_rails)) and on the client
+
+I have used this exact architecture on several big client projects, where I was free to come up with the project structure from scratch.
+After a lot of experimentation and simplification, this is the stack where all the pieces clicked in the end.
+
+The only problem? It's still a work in progress. The code exists, but needs to be cleaned up and open sourced.
+
+## Getting started
+
+First, install kea globally:
+
+```
+npm install kea
+```
+
+Then run `kea new` to create a new project and run it:
+
+```
+kea new test_project
+cd test_project
+npm start
+```
+
+Open your browser at `http://localhost:4000/`, play with the demo app and start coding right away!
+
+
+## Sponsorship
+
+`kea` is currently my Sunday afternoon project. That means development is slow. Feel free to get in contact if you wish to sponsor this effort in any way.
+
+---
+*Image from https://www.flickr.com/photos/mollivan_jon/126900211/*

New alerts

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

252039

increased by150821.56%

Number of package files

8

increased by166.67%

Lines of code

74

increased by3600%

Number of lines in readme file

67

increased by2133.33%

Worsened metrics

Dependency count

1

increased byInfinity%

Number of low supply chain risk alerts

2

increased by100%

Dependency changes

• + Addedcommander@^2.9.0

• + Addedcommander@2.20.3(transitive)