Controk Frontend Web

We used...

Angular 1 Style Guide

Idiomatic.js

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Note: This is the Frontend Web part of the Controk system and may have some features faked for demonstrative purposes. Click here for the fully working system.

Prerequisites

These instructions will build the environment to run commands on the project.

• NodeJS
• NPM

Installing

Manual

• Create .env file, based on .env.example, and set your environment as you wish;
• npm install;
• npm run standalone (for demonstration only);
• npm start (for when you have the WebService and the Socket running);

Based on "docker"

• The next command will give you a running server. Needing anything specific, change in docker-compose.yml;
• docker-compose build;
• docker-compose up.

The server must be running at [http://localhost:8888/].

Running the tests

Manual

• Create a ".env" file base on ".env.example" in the project's root;
• Make sure you have Google Chrome
• npm test.

Based on "docker"

• Open the docker-compose.yml file with your favorite text editor and change the frontend-web service command to npm test;
• docker-compose up.

Deployment

Clone the project:

git clone https://github.com/jourdanrodrigues/controk-frontend-web

Build the project with docker compose:

docker-compose build

Raise the project:

docker-compose up

Built With

• AngularJS
• NodeJS
• Gulp

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Jourdan Rodrigues - Initial work - Jourdan Rodrigues

See also the list of [contributors][contributors] who participated in this project.