README.md

Opp

Install locally

Prerequisites:

• NodeJs > 14.15.0

Install deps:

• Run npm i

Development

IDE

• [!Important] Use Visual Studio Code for development Not only it provides better intellisense and type checking, it has a few default linting rules that apply automatically as you code.
• Install Angular Language Service VSC extension to get even better intellisense.
• Install ESLint VSC extension for real time linting error information.

Run locally

If you just got latest, make sure you have all dependencies installed:

• Run npm i

If you want to develop with mock data, the just run npm start.

If you want to run front-end against the server, you need to start it. Start the server on port 5000. You can do it via running docker commands from the opp directory:

docker build -t opp .
docker run -p 5000:5000 -it opp

Then run one of the following commands, which will start local dev server, but point any /api requests to the running instance of Opp server

npm run start:with-server

Generate Test data

• Open docker container console and run:

python3 dummy_data.py

Modify the dummy_data.py script to adjust number of categories/items generated

Testing PWA functionality

• generate cert files - run ./cert/makeCert.bat
• register the generated certificate in your OS
• npm i -g http-server - only once
• npm run build:prod - this creates production build in ./dist folder
• npm run server:dist - serves files from ./dist
• open https://localhost:8080/

Test user credentials:

• username: demo
• password: demo
• passphrase: phrase

Build

Dev build:

• npm run build.

Prod build:

Creates assets to be deployed to production server

• npm run build:prod

Demo build:

Creates assets to be deployed to the demo server

• npm run build:demo

Running unit tests

• npm run test

Running lint

• npm run lint

Evaluate bundles:

• npm run build:stats && npm run source-map-explorer

Technology to learn:

Core concepts

• Angular
• RxJs - See tutorials under Resource
• Elf

UI Frameworks used:

• Angular Material