Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.47 KB

README.md

File metadata and controls

59 lines (44 loc) · 2.47 KB
Raw

Noterious

Noterious

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!

Prerequisites

Before you start, you will need:

Get the Code

Now go ahead and download the code.

git clone https://github.com/simpulton/noterious.git
cd noterious

Setting up Firebase

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 the Enable 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 the ENDPOINT_URI constant with the URL you copied. MAKE SURE there is a trailing slash at the end of the URL.
  • Open the src/app/common/services/auth-service.js and modify config according to the template you can find on https://console.firebase.google.com/project/<your-app-name>/settings/general/ clicking Add Firebase to your web app button

Run the App

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!

Testing

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 with gulp. If you do not have it installed globally, run npm 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.