Skip to content
OBLIQ Progressive Web Application V2.0
JavaScript CSS HTML
Branch: master
Clone or download
Latest commit c51145d Oct 26, 2017

README.md

Commitizen friendly

OBLIQ Progressive Web App   Tweet

About

This repository hosts the assets for the Obliq Progressive Web App, developed by Appticles.

Regulatory Information

In order to keep everyone in the development community feeling safe and appreciated, we added a Code of conduct that we should all try to adhere to. Please go ahead and read it before you move further with your work: CODE_OF_CONDUCT.md.

For information regarding making contributions to the repository, please take a look at our CONTRIBUTING.md document.

Environment setup

To get your development environment up and running, please refer to the environment configuration document. You will find more information about the tools you need to install and the first steps needed to start developing using this seed project: ENVIRONMENT_SETUP.md

Coding standards

For the coding part, we rely heavily on John Papa's Angular 1 style guide which is baked into our development process. We use ESLint to run our code style validations, and the angular ESLint plugin to validate the code. The code validation step runs on buffer save. Every time you save a file, ESLint will run and check your code for stylistic errors. There is also a pre-commit hook that runs code validation against your code, so you will not be able to commit code that does not adhere to the style guide, into the repository. However, this can be bypassed, but it is a conscious/intended act rather than a mistake. For more information, please refer to John Papa's Angular 1 style guide.

Naming conventions

For all our modules we use the naming conventions outlined in the style guide mentioned above so please be sure to check out the Folders-by-Feature Structure section.

Commit message style guide

We use the AngularJS committing style guide for all our projects, thus, any commit message you write must follow the structure outlined below:

<type>(<scope>): <subject>  
<BLANK LINE>  
<body>  
<BLANK LINE>  
<footer>

To get more details on the meaning of each item in the commit message, please follow the links below:

Styling the application

We all know CSS is hard to tame, so to make it easy for you we give you our battle-tested method for styling your application while remaining sane - STYLING.md.

Testing

While developing any application on-top of the Appticles Starter Kit, we take a TDD(Test-Driven Development) approach. This means that we first write some failing tests, and then we implement the functionality to make those tests pass. This way, we are more focused on what we need to implement, and not waste a lot of our time thinking about solutions that do not fit our current implementation.

We test our application in two ways:

  • Unit tests - Karma + Jasmine
  • End-to-end(E2E) tests - Protractor

For more information about our current testing toolkit please visit the official docs of Karma, Jasmine and Protractor.

Production process

The process to make an application production ready is detailed in the PRODUCTION.md document.

Useful resources

For a list of useful resources on various aspects of Ionic/AngularJS take a look at the USEFUL_LINKS.md document.

You can’t perform that action at this time.