Kime Frontend

Kime is a web app for upscaling and enhancing images using generative adversarial networks. This repository contains the code for the frontend, written using Angular and TypeScript.

Getting started

1. Go to project folder and install dependencies:

npm install

2. Launch development server, and open localhost:4200 in your browser:

npm start

Project structure

dist/                        web app production build
docs/                        project documentation
src/                         project source code
|- app/                      app components
|  |- core/                  core module (singleton services and single-use components)
|  |- shared/                shared module  (common components, directives and pipes)
|  |- app.component.*        app root component (shell)
|  |- app.module.ts          app root module definition
|  |- app-routing.module.ts  app routes
|  +- ...                    additional modules and components
|- assets/                   app assets (images, fonts, sounds...)
|- environments/             values for various build environments
|- theme/                    app global scss variables and theme
|- translations/             translations files
|- index.html                html entry point
|- main.scss                 global style entry point
|- main.ts                   app entry point
|- polyfills.ts              polyfills needed by Angular
+- test.ts                   unit tests entry point
reports/                     test and coverage reports
proxy.conf.js                backend proxy configuration

Dependencies

Libraries

• Angular
• Bootstrap 4
• ng-bootsrap
• Font Awesome
• RxJS
• ngx-translate
• Lodash

Toolchain

Development, build and quality processes are based on angular-cli and NPM scripts, which includes:

• Optimized build and bundling process with Webpack
• Development server with backend proxy and live reload
• Cross-browser CSS with autoprefixer and browserslist
• Asset revisioning for better cache management
• Unit tests using Jasmine and Karma
• End-to-end tests using Protractor
• Static code analysis: TSLint, Codelyzer, Stylelint and HTMLHint
• Local knowledgebase server using Hads
• Automatic code formatting with Prettier

Task automation

Task automation is based on NPM scripts. Tasks are mostly based on the angular-cli tool. Use ng help to get more help or go check out the Angular-CLI README.

Task	Description
npm start	Run development server on http://localhost:4200/
npm run build	Lint code and build web app
npm test	Run unit tests via Karma in watch mode
npm run test:ci	Lint code and run unit tests once for continuous integration
npm run lint	Lint code
npm run docs	Display project documentation
npm run prettier	Automatically format all .ts, .js & .scss files

When building the application, you can specify the target configuration using the additional flag --configuration <name> (do not forget to prepend -- to pass arguments to npm scripts).

The default build configuration is prod.

Development server

Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. You should not use ng serve directly, as it does not use the backend proxy configuration by default.

Code scaffolding

Run npm run generate -- component <name> to generate a new component. You can also use npm run generate -- directive|pipe|service|class|module.

If you have installed angular-cli globally with npm install -g @angular/cli, you can also use the command ng generate directly.

Code formatting

All .ts, .js & .scss files in this project are formatted automatically using Prettier, and enforced via the test:ci script.

You can also force code formatting by running the command npm run prettier.