Welcome to the Noterious app. It is built using AngularJS with Firebase as the backend. If you would like to see it in action, visit http://noterio.us; if you want to run it locally, read on!
Before you start, you will need:
To start off, you will need to set up an account with Firebase:
- Navigate to firebase.com and click
Sign Up
- Create an app (named whatever you want)
- Click on your new app's URL
- Navigate to the
Login & Auth
section of your dashboard and check theEnable Email & Password Authentication
checkbox. - Navigate to the data tab and then copy the URL from your address bar. It should have the form of
https://<your-app-name>.firebaseio.com
. - Open the
src/app/noterious.js
file and replace theENDPOINT_URI
constant with the URL you copied. MAKE SURE there is a trailing slash at the end of the URL.
Now go ahead and download the code.
git clone https://github.com/jsBlackBelt/noterious.git
cd noterious
Next, you need to install all of your dependencies.
npm install
And install and run the serve
package so you can build the app.
npm install -g serve
serve src/
Navigate to http://localhost:3000
and view the gloriousness that is Noterious!
Noterious uses Gulp for running tests.
You can start a TDD workflow with gulp tdd
.
Note: you must have
Gulp CLI
installed in order to run the tests withgulp
. If you do not have it installed globally, runnpm install -g gulp-cli
or use the method below.
If you prefer to use the local installation of gulp managed by npm, you can start the TDD workflow with
node ./node_modules/gulp/bin/gulp.js tdd
For continuous integration, you can execute tests with gulp test
or npm test
.