Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
roc - npm Package Compare versions
Comparing version 1.0.0-alpha5 to 1.0.0-alpha7
@@ -42,2 +42,7 @@ 'use strict'; | ||
| // if product requires an alpha version of cli an exact version match is not needed | ||
| if (requiredRocVersion.indexOf('-alpha') > -1) { | ||
| return true; | ||
| } | ||
| if (!_semver2['default'].satisfies(getVersion(), requiredRocVersion)) { | ||
@@ -44,0 +49,0 @@ var state = _semver2['default'].ltr(getVersion(), requiredRocVersion) ? 'newer' : 'older'; |
| { | ||
| "name": "roc", | ||
| "version": "1.0.0-alpha5", | ||
| "version": "1.0.0-alpha7", | ||
| "description": "CLI for the Roc ecosystem", | ||
@@ -10,4 +10,8 @@ "main": "./lib/index.js", | ||
| "build": "babel src --out-dir lib --source-maps", | ||
| "clean": "rimraf lib docs", | ||
| "test": "npm run lint", | ||
| "build:watch": "npm run build -- --watch", | ||
| "clean": "rimraf lib docs coverage", | ||
| "test": "npm run lint && npm run test:coverage", | ||
| "test:unit": "mocha --compilers js:babel/register test/", | ||
| "test:unit:watch": "mocha --watch --compilers js:babel/register test/", | ||
| "test:coverage": "isparta cover _mocha -- --compilers js:babel/register", | ||
| "lint": "eslint .", | ||
@@ -36,4 +40,9 @@ "check": "ncu", | ||
| "babel-eslint": "~4.1.1", | ||
| "chai": "~3.4.1", | ||
| "codeclimate-test-reporter": "~0.1.1", | ||
| "coveralls": "~2.11.4", | ||
| "eslint": "~1.9.0", | ||
| "eslint-config-vgno": "~5.0.0", | ||
| "isparta": "~3.5.3", | ||
| "mocha": "~2.3.4", | ||
| "npm-check-updates": "~2.4.2", | ||
@@ -40,0 +49,0 @@ "rimraf": "~2.4.3" |
@@ -1,18 +0,38 @@ | ||
| # Roc | ||
| # Roc - CLI for the Roc ecosystem | ||
| Develop modern web applications and components without the boilerplate fragmentation. | ||
|  | ||
| [](https://www.npmjs.com/package/roc) | ||
| [](https://travis-ci.org/vgno/roc) | ||
| [](https://coveralls.io/github/vgno/roc?branch=master) | ||
| [](https://codeclimate.com/github/vgno/roc) | ||
| [](https://codeclimate.com/github/vgno/roc) | ||
| [](https://david-dm.org/vgno/roc) | ||
| ## Modern Application Development Ecosystem | ||
| _Project status is currently WIP proof of concept_ | ||
| _Project status is currently work in progress and proof of concept_ | ||
| We have started to implement the first few products based on Roc. These products are not yet in production. You have been warned! | ||
| Provides a complete ecosystem for developing modern applications. | ||
| --- | ||
| Roc provides a complete ecosystem for developing modern applications. | ||
| Sweeps common complexities into easy-to-use packages with extendable APIs. | ||
| Composes some great open source tools and make them easy to use with a streamlined CLI and configuration/extension system. Direct your focus to _writing great software_ and away from juggling boilerplate and dependencies. Built on top of the node ecosystem. | ||
| Composes some great open source tools and make them easy to use with a streamlined command line interface and configuration/extension system. | ||
| Direct your focus to _writing great software_ and away from juggling boilerplate and dependencies. Roc is built on top of the Node.js ecosystem. | ||
| ### Example of tasks handled by extensions | ||
| - Building and bundling through Webpack | ||
| - Web server through Koa | ||
| - First class developer experience | ||
| - React (complete with Redux and server side rendering) | ||
| - Building and bundling through [Webpack](http://webpack.github.io/) | ||
| - Web server through [Koa](http://koajs.com/) | ||
| - [React](http://facebook.github.io/react/) (complete with [Redux](https://github.com/rackt/redux) and server side rendering) | ||
| - First class developer experience featuring hot code reloading and [Browsersync](http://browsersync.io) | ||
| Common tasks and boilerplate code does not exist in a Roc application but in extensions making it easier to maintain and update. | ||
| Common tasks and boilerplate code does not exist in a Roc application but in extensions installed with `npm` making it easier to maintain and update. Roc extensions are opinionated by design. | ||
| ### Simplicity | ||
| As a user of Roc to create components or applications you will mainly direct your attention to your application code, configuration limited to your own project and using the command line interface. You do not need a deep understanding of how Roc makes your life simpler. We do however encourage you to take a deep-dive and contribute. | ||
| ## Get started | ||
@@ -24,19 +44,53 @@ ### Install Roc | ||
| This provides you with a really simple command line interface. Only Linux and OS X _currently_ supported. | ||
| ### Awesome Redux + React application | ||
| Create application directory. Name it whatever you like. We used react-app. | ||
| ``` | ||
| mkdir react-app && cd react-app | ||
| ``` | ||
| Init application starting point | ||
| ``` | ||
| roc init web-react | ||
| ``` | ||
| Build and start the application in development mode | ||
| ``` | ||
| roc dev | ||
| ``` | ||
| `roc init web-react` uses the starting point [roc-base-web-react](https://github.com/vgno/roc-base-web) from Github | ||
| Suitable for more ambitious web-applications that prefer **React** views, **universal rendering** and established library **Redux** for unidirectional dataflow. | ||
| ### Basic web application | ||
| Create application directory. Name it whatever you like. We used basic. | ||
| ``` | ||
| mkdir basic && cd basic | ||
| ``` | ||
| Init application starting point | ||
| ``` | ||
| roc init web | ||
| roc dev | ||
| ``` | ||
| ### Basic Redux & React application | ||
| Build and start the application in development mode | ||
| ``` | ||
| mkdir redux && cd redux | ||
| roc init web-react | ||
| roc dev | ||
| ``` | ||
| `roc help` will provide available actions. | ||
| `dev` starts the application locally in development mode with hot code reloading and Browersync. View your application at http://localhost:3002 | ||
| `roc init web` uses the starting point [roc-base-web](https://github.com/vgno/roc-base-web) from Github | ||
| Suitable for serving static files and rendering `html` with basic `javascript` on the client. | ||
| ### Where to go from here | ||
| `roc help` will print available actions. | ||
| `roc dev` starts the application locally in development mode with _hot code reloading_ and _Browersync_. | ||
| `roc dev --help` will list all **options available to your current extension**. | ||
| Be sure to read through this as minor adjustments to your `roc.config.js` is a very common use-case. Also check out defaults for [web](https://github.com/vgno/roc-web/blob/master/src/roc/config/roc.config.js) and [web-react](https://github.com/vgno/roc-web-react/blob/master/src/roc/config/roc.config.js) | ||
| View your application at http://localhost:3002 using default configuration. | ||
| ## Motivation | ||
@@ -46,7 +100,9 @@ Roc was born out of the need to create modern applications following the correct conventions and using best practices consistently. | ||
| ## Read the code | ||
| cli: TODO | ||
| web: TODO | ||
| web-react: TODO | ||
| config: TODO | ||
| ## Eco system | ||
| | Project | Github page | | ||
| ----------|-------------- | ||
| | CLI (this project) | https://github.com/vgno/roc | | ||
| | Roc Config | https://github.com/vgno/roc-config | | ||
| | Roc Web | https://github.com/vgno/roc-web | | ||
| | Roc Web React | https://github.com/vgno/roc-web-react | | ||
@@ -53,0 +109,0 @@ ## Roadmap |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by6.82%
64354
- Lines of code
- increased by0.76%
530
- Number of lines in readme file
- increased by93.33%
116
Worsened metrics
- Dev dependency count
- increased by83.33%
11
No dependency changes