Skip to content

CSCfi/aoe-web-frontend

Repository files navigation

Service Component Links to GitHub Repositories

Project is based on CoreUI Angular 2+ Admin template.

Main tools are Angular, Bootstrap 4 and SASS

Installation

Clone repo

# clone the repo
$ git clone https://github.com/CSCfi/aoe-web-frontend.git

# go into app's directory
$ cd aoe-frontend

# install app's dependencies
$ npm install

Usage

# serve with hot reload at localhost:4200.
$ ng serve

# build for production with minification
$ ng build

# build documentation at ./documentation/
$ npm run compodoc

Prettier

Enable Prettier to format code on save.

VS Code

  1. Install Prettier - Code formatter extension
  2. Make Prettier your default formatter
  3. Enable format on save

WebStorm

Follow the instructions.

Prettier package: /aoe-web-frontend/node_modules/prettier
Run for files: {**/*,*}.{ts,scss,html}
On 'Reformat Code' action: true
On save: true

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

aoe-web-frontend/
├── src/
│   ├── app/
│   ├── assets/
│   ├── environments/
│   ├── files/
│   ├── scss/
│   ├── index.html
│   └── ...
├── angular.json
├── ...
├── package.json
└── ...