Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carbonfive/hi-blank-node-app
Starting point for a node application
https://github.com/carbonfive/hi-blank-node-app
Last synced: about 1 month ago
JSON representation
Starting point for a node application
- Host: GitHub
- URL: https://github.com/carbonfive/hi-blank-node-app
- Owner: carbonfive
- Created: 2013-01-06T16:40:31.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2013-01-07T07:09:04.000Z (about 12 years ago)
- Last Synced: 2024-04-15T12:18:27.610Z (9 months ago)
- Language: JavaScript
- Size: 230 KB
- Stars: 3
- Watchers: 79
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A Blank Node Application
## Use this app as a new starting point or just for reference
## Customize it as needed
### Includes:
- express to start listening to http requests and or a socket.io events
- mocha-chai test framework with unit, integration and headless browser testing with [phantomjs](http://phantomjs.org/)
- coffee-script setup for development and for testing
- cakefile to run automated tests or to watch tests
- stylus and nib for a light-weight css solution
- jade for rendering views
- an organized MVC+Services directory structure for quickly developing core functionality
- class loader mechanism to auto-load models and services
- routing configuration file (comming soon)
- support for sessions and cookies (comming soon!)
- connection to redis and/or mongoDB with test/dev/prod environments (comming soon!)
- an application class to easily configure the server (comming soon!)
### To Start Server:
````
npm install
npm start
````
### To Start Client:
````
browse to [ http://localhost:8888 ]
````
### To Execute Specs:
````
npm test
````
requires [phantomjs](http://phantomjs.org/), which is used for headless browser testing.
### To Install Phantom
````
brew update
brew install phantomjs
````
### Ξ The MVP #1:
1. Ξ feature 1
* Ξ /endpoint1/:param/path
2. Ξ feature 2
* Ξ /endpoint2/:param/path
3. Ξ feature 3
* Ξ /endpoint3/:param/path
### Ξ The MVP #2:
1. Ξ feature 1
* Ξ /endpoint1/:param/path
2. Ξ feature 2
* Ξ /endpoint2/:param/path
3. Ξ feature 3
* Ξ /endpoint3/:param/path
### Ξ TO DO
````
+ deploy
+ write unit tests for models and services (see spec/server/models[services])
+ write integration tests for controllers (see spec/server/controllers)
+ write usage tests using phantomjs for views (see spec/client)
+ write MVP #1
+ write MVP #2
````
> **Key**
> Ξ ToDo
> ♥ In Progres
> ✓ Complete