TwoToc code
[YouAndWeb_TwoToc] / README.md
diff --git a/README.md b/README.md
new file mode 100755 (executable)
index 0000000..37188ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# dashboard
+
+This project was generated with the [Angular Full-Stack Generator](https://github.com/DaftMonk/generator-angular-fullstack) version 3.0.0-rc5.
+
+## Getting Started
+
+### Prerequisites
+
+- [Git](https://git-scm.com/)
+- [Node.js and NPM](nodejs.org) >= v0.12.0
+- [Bower](bower.io) (`npm install --global bower`)
+- [Ruby](https://www.ruby-lang.org) and then `gem install sass`
+- [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)
+- [MongoDB](https://www.mongodb.org/) - Keep a running daemon with `mongod`
+
+### Developing
+0. (PTKDev FIX) Run `sudo npm install -g grunt && sudo npm install --global grunt-cli && sudo npm install --global bower` `sudo apt-get install nodejs-legacy npm nodejs mongodb-server`
+
+1. Run `npm install` to install server dependencies.
+
+2. Run `bower install` to install front-end dependencies.
+
+3. Run `mongod` in a separate shell to keep an instance of the MongoDB Daemon running
+
+4. Run `grunt serve` to start the development server. It should automatically open the client in your browser when ready.
+
+## Build & development
+
+Run `grunt build` for building and `grunt serve` for preview.
+
+## Testing
+
+Running `npm test` will run the unit tests with karma.