Home

Awesome

Online Board

Build Status CircleCI Coverage Status Commitizen friendly

This project is running Live at onlineboard.sonnywebdesign.com

Note

If you are updating from a version <= 0.1.0, you must reinstall all the npm dependencies with:

$ npm cache clean
$ npm install

# Or using Yarn

$ yarn upgrade

Prerequisites

The project has dependencies that require Node 6.9.0 or higher, together with NPM 3 or higher.

Development server

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run npm run build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run npm test to execute the unit tests via Karma.

Running end-to-end tests

Run npm run e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via npm start.

Deploying to Firebase

Prerequisites

  1. Create a free Firebase account at https://firebase.google.com
  2. Create a project from your Firebase account console
  3. Configure the authentication providers for your Firebase project from your Firebase account console

Configure this app with your project-specific details

// .firebaserc

{
  "projects": {
    "default": "your-project-id"
  }
}

// src/firebase/index.ts

const firebaseConfig = {
  apiKey: 'your api key',
  authDomain: 'your-project-id.firebaseapp.com',
  databaseURL: 'https://your-project-id.firebaseio.com',
  storageBucket: 'your-project-id.appspot.com'
};

Install firebase-tools

$ npm install -g firebase-tools

Build and deploy the app

$ npm run build
$ firebase login
$ firebase use default
$ firebase deploy

Contributing

This package is using the AngularJS commit messages as default way to contribute with Commitizen node package integrated in this repository.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Add your changes: git add .
  4. Commit your changes: npm run commit
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request :sunglasses:

Changelog

Changelog available here

License

MIT License © Andrea SonnY