Skip to content

andreasonny83/the-wall-of-quotes

Repository files navigation

Build Status Commitizen friendly semantic-release

The Wall Of Quotes

Discover and share quotes and sayings

This is an Angular2 single page web application using Firebase.

Note

This project is very much still a work in progress.

Prerequisites

This project has dependencies that require Node 4 or higher with NPM 3 or higher.

Table of Contents

Installation

BEFORE YOU INSTALL: please read the prerequisites

Clone your local copy of this repository with:

git clone git@github.com:andreasonny83/the-wall-of-quotes.git

Usage

Generating and serving the project via a development server

npm start

Navigate to http://localhost:8100/. The app will automatically reload if you change any of the source files.

Unit tests

npm test

This task will trigger the unit test task using Karma. All files ending with .spec.ts will be automatically included in the test queue.

E2E tests

npm run e2e

This task will run a series of E2E test using Protractor. All files ending with .e2e-spec.ts will be automatically included in the test queue. The task is aimed to verify that all the elements and components are correctly rendered on the user's screen on different browsers / screen sizes.

Creating a build

npm build

The build artifacts will be stored in the dist/ directory.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Stage your local files: 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 :D

License

MIT License © Andrea SonnY