Working VS player mobile theme for Open Labyrinth
An online demo is available online at: http://medresearch2.med.auth.gr/waves-mob
A mobile player for Open Labyrinth virtual patients. Although the Open Labyrinth (OL) application is a client-server application and, thus, can be run using a mobile browser, the user experience (UX) suffers in small screens.
We followed a bottom-to-up approach, designing the player not only to fit in small screens, but also to maximise the user experience, when played in a mobile device.
Technical installation instructions
- Clone the following repository
git clone https://github.com/wavesproject/OL-mobile
- Go to project folder and install dependencies:
- Launch development server, and open localhost:4200 in your browser:
dist/ compiled version docs/ project docs and coding guides e2e/ end-to-end tests 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
Task automation is based on NPM scripts.
||Run development server on http://localhost:4200/|
||Lint code and build app for production in dist/ folder|
||Run unit tests via Karma in watch mode|
||Lint code and run unit tests once for continuous integration|
||Run e2e tests using Protractor|
||Extract strings from code and templates to src/app/translations/template.json|
||Display project documentation|
When building the application, you can specify the target environment using the additional
flag --env <name> (do not forget to prepend -- to pass arguments to npm scripts).
The default build environment is prod.
This project was generated with ngX-Rocket version 1.3.3
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.
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.
Additional tools Tasks are mostly based on the angular-cli tool. Use ng help to get more help or go check out the Angular-CLI README.
What's in the box
The app template is based on HTML5, TypeScript and Sass. The translation files use the common JSON format. Tools
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 knowledge base server using Hads
- Angular 2
- Bootstrap 4
- Font Awesome
End users are free to contribute through pull requests in the project repository.