-
Notifications
You must be signed in to change notification settings - Fork 1
/
params.json
6 lines (6 loc) · 4.62 KB
/
params.json
1
2
3
4
5
6
{
"name": "expressBuilder",
"tagline": "A bleeding-edge \"Big Picture\" application starter and manager",
"body": "# Things to do with Gulp & Node\r\n\r\n## Welcome to expressBuilder\r\nThis package is for advanced developers who know their way around task managers and npm, and just want a quick launching point. This builder is also brilliant for new and eager up-starts who are eager for a way to get their foot in the door with useful and worth-while open-sourcey skills, learning how to build and manage scaleable HTML5 JavaScript applications using a terminal, node, and gulp alone. \r\n\r\nIts up to you if you need to access files through an IDE as an extra step. Its easy enough to network share the project dir that your building, and edit/build from your IDE across some network. Its just easy. You will have to either skip to the `Easy setup` section from here, or Read on to continue, depending on your level of patience. Tap-on die-hard coders!\r\n\r\n### Versatility is key since you never know which direction technology is leading, to which type of application you will build next\r\nUsing this builder gives you a way to fully control what type of application, and to help you get it out the door fast. It doesn't matter what tools you want to choose from to do the job. Using npm only is encouraged. This is an anti-bower-need, anti-grunt-need setup to keep things really slim. Any projects GitHub repo URL can simply be added into the gulp task, called \"vendor\", whether its a RUBY / readthis app, a raw bare-bones framework that your creating in any design pattern, or an Angular/Redux masterpiece, this is a great launching point. \r\n\r\n### Examples aim to help you rapid start a mainstream HTML5 application\r\nKick off right away with a working site, with CRUD. The main example uses Express/Mongo with MongooseODM. The site includes a database, with a RESTful API/CRUD. \r\n\r\n### Live reload\r\nOne of the primary features that is core to continue to function flawlessly on all builds of expressBuilder is Live reload. Live reload is integrated into `gulp-live-server` so that a watch can be set both on the src build files, and again on the build dir so that after they are compiled they can come up on save (less than a second on all devices). This is superb when your developing RWD, CSS and TEMPLATE authoring, even client and server-side js. This takes efffect on every device/browser opened on the LAN, in a second, by the press of save on your IDE, or :w on vim. This works without browser extensions allowing you to immediately reap from any browsing device. \r\n\r\n### Easy setup\r\n- git [clone](https://github.com/brian-lamb-software-engineer/expressBuilder.git) into your projects dir onto a machine that has a working nodejs installation configured and ready to run `npm` (can be through a terminal, so long as the port for node is available, currently that is port 3003, you can change it)\r\n- cd to the app root dir, run `npm install`\r\n\r\n### First steps for orientation\r\n- run `gulp all`\r\n- open any device browsers, browse to url (http://ip:port) where your running gulp, e.g. (http://192.168.1.6:3003) or (http://sharedhosting.com:3001) etc.. \r\n- see that the application loads, be excited to test Live Reload working next!\r\n\r\n### First steps for development\r\n- branch the app, so you can start development\r\n- cd to the app dir, `gulp all`(reducing to `gulp`) until you get a clean output and browser refresh, then commit these core changes\r\n- Peek and orient yourself with the client-side source files \r\n - cd to the `src/` see models/controllers/views \r\n - Edit and save a file, watch gulp, and device output. (adjust any gulp tasks to your likings)\r\n - **This is the amazing part**, watch your page come back to life right away as the gulp task brings it back online. The application automatically reaches back out to its mother-ship on all devices that still have it loaded!!\r\n- Peek at the middle-ware `index.js` file in the app root which bootstraps the app\r\n- Peek at the back end node server in bin/\r\n\r\n### Next steps\r\n#### Changing out or adding in technologies \r\n- branch the app for your new core technologies \r\n- adjust `package.json` file\r\n- run `npm install`\r\n- edit gulp tasks until the build makes you satisfied, commit the project\r\n\r\n#### Support or Contact\r\nHaving trouble with Pages? Check out our [documentation](https://github.com/brian-lamb-software-engineer/expressBuilder/wiki/About-expressBuilder) or [issue](https://github.com/brian-lamb-software-engineer/expressBuilder/issues).\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}