alexandre83/chatons-front

Angular Chatons project

A project chatons built with Angular.

Be careful, this chatons has a strong dependency with Angular, you should read the docs before starting.

Table of content

• Angular Chatons project
  • Table of content
  • Getting Started
    • Prerequisites
    • Installing dependencies
    • Run
  • Overview
    • Base project structure
  • Build
  • Automated NPM tasks
    • Checking code style
    • Generate documentation
  • Deploy

Getting Started

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

This project chatons provides an Angular skeleton app that you can extends to build your own app. It also provide some reusing components and providers to help you building an app faster.

Prerequisites

• npm

  Needed to install Javascript dependencies.

Installing dependencies

At the root directory of the chatons, run :

npm install

Run

At the root directory of the chatons, run :

npm start

Internally, the NPM command will launch the ng serve command.

Overview

Base project structure

|-- node_modules/          --> Javascript dependencies installed from NPM
|-- src/                   --> Sources files root directory
    |-- app/               --> Modules files root directory
        |-- bootstrap/       --> Bootstrap Component
        |-- modules/       --> Module
        |-- app.module.ts  --> App module (first loaded module by the Angular app)
    |-- assets/            --> Assets directory (images etc...)
    |-- environments/      --> Application environments files
    |-- scss/              --> Global SCSS files
    |-- index.html         --> HTML entry point
    |-- main.ts            --> Angular entry point
    |-- test.ts            --> Angular testing entry point
    |-- polyfills.ts       --> Polyfills
    |-- tsconfig.json      --> Application typescript config
    |-- tsconfig.spec.json --> Application typescript config in test env.
|-- .gitignore
|-- .prettierrc
|-- angular.json          --> Angular config
|-- package.json
|-- package-lock.json  
|-- tsconfig.json          --> Parent typescript config
|-- tslint.json            --> TSlint configuration file

Build

At the root directory of the chatons, run :

npm run build

Internally, the NPM command will launch the ng build command.

Will produce the built files in the build directory.

Automated NPM tasks

All the following tasks must be ran at root directory of the chatons.

Checking code style

npm run style

Using Codelyzer.

Generate documentation

npm run doc

Using Compodoc, configured to run in the src directory. Will generate the HTML documentation in the documentation directory.

Deploy

npm run prestart

Install dependencies and build project and documentation

npm run deploy

Generate docker image according to Dockerfile and create container based on previous image created