7.5 KiB
OpenSlides 3 Client
Prototype application for OpenSlides 3.0 (Client). Currently under constant heavy maintenance.
Development Info
As an Angular project, Angular CLI is highly recommended to create components and services. See https://angular.io/guide/quickstart for details.
Contribution Info
Please respect the code-style defined in .editorconf and .pretierrc.
Code alignment should be automatically corrected by the pre-commit hooks.
Adjust your editor to the .editorconfig to avoid surprises.
See https://editorconfig.org/ for details.
Pre-Commit Hooks
Before commiting, new code will automatically be aligned to the definitions set in the
.prettierrc.
Furthermore, new code has to pass linting.
Our pre-commit hooks are:
pretty-quick --staged and lint
See package.json for details.
Documentation Info
The documentation can be generated by running npm run compodoc.
A new web server will be started on http://localhost:8080
Once running, the documentation will be updated automatically.
You can run it on another port, with adding your local port after the command. If no port specified, it will try to use 8080.
Please document new code using JSDoc tags. See https://compodoc.app/guides/jsdoc-tags.html for details.
Development server
Run npm start for a development server. Navigate to http://localhost:4200/.
The app will automatically reload if you change any of the source files.
A running OpenSlides (2.2 or higher) instance is expected on port 8000.
Start OpenSlides as usual using
python manage.py start --no-browser --host 0.0.0.0
Translation
We are using ngx-translate for translation purposes.
Use npm run extract to extract strings and update elements an with translation functions.
Language files can be found in /src/assets/i18n.
Used software
OpenSlides uses the following software or parts of them:
- @angular/animations@7.2.14, License: MIT
- @angular/cdk-experimental@7.3.7, License: MIT
- @angular/cdk@7.3.7, License: MIT
- @angular/common@7.2.14, License: MIT
- @angular/compiler@7.2.14, License: MIT
- @angular/core@7.2.14, License: MIT
- @angular/forms@7.2.14, License: MIT
- @angular/http@7.2.14, License: MIT
- @angular/material@7.3.7, License: MIT
- @angular/platform-browser-dynamic@7.2.14, License: MIT
- @angular/platform-browser@7.2.14, License: MIT
- @angular/pwa@0.13.8, License: MIT
- @angular/router@7.2.14, License: MIT
- @angular/service-worker@7.2.14, License: MIT
- @ngx-pwa/local-storage@7.4.2, License: MIT
- @ngx-translate/core@11.0.1, License: MIT
- @ngx-translate/http-loader@4.0.0, License: MIT
- @pebula/ngrid-material@1.0.0-alpha.20, License: MIT
- @pebula/ngrid@1.0.0-alpha.20, License: MIT
- @pebula/utils@1.0.0-alpha.3, License: MIT
- @tinymce/tinymce-angular@3.0.0, License: Apache-2.0
- core-js@3.0.1, License: MIT
- css-element-queries@1.1.1, License: MIT
- exceljs@1.9.1, License: MIT
- file-saver@2.0.1, License: MIT
- hammerjs@2.0.8, License: MIT
- lz4js@0.2.0, License: ISC
- material-icon-font@0.1.0, License: ISC
- ng-pick-datetime@7.0.0, License: MIT
- ng2-pdf-viewer@5.3.2, License: MIT
- ngx-file-drop@6.0.0, License: MIT
- ngx-mat-select-search@1.7.2, License: MIT
- ngx-papaparse@3.0.2, License: MIT
- pdfmake@0.1.54, License: MIT
- po2json@1.0.0-alpha, License: GNU Library General Public License
- rxjs@6.5.1, License: Apache-2.0
- tinymce@4.9.4, License: LGPL-2.1
- uuid@3.3.2, License: MIT
- zone.js@0.8.29, License: MIT
- @angular-devkit/build-angular@0.13.8, License: MIT
- @angular/cli@7.3.8, License: MIT
- @angular/compiler-cli@7.2.14, License: MIT
- @angular/language-service@7.2.14, License: MIT
- @biesbjerg/ngx-translate-extract@2.3.4, License: MIT
- @compodoc/compodoc@1.1.9, License: MIT
- @types/jasmine@3.3.12, License: MIT
- @types/jasminewd2@2.0.6, License: MIT
- @types/node@11.13.7, License: MIT
- @types/yargs@13.0.0, License: MIT
- codelyzer@5.0.1, License: MIT
- husky@1.3.1, License: MIT
- jasmine-core@3.4.0, License: MIT
- jasmine-spec-reporter@4.2.1, License: Apache-2.0
- karma-chrome-launcher@2.2.0, License: MIT
- karma-coverage-istanbul-reporter@2.0.5, License: MIT
- karma-jasmine-html-reporter@1.4.0, License: MIT
- karma-jasmine@2.0.1, License: MIT
- karma@4.1.0, License: MIT
- npm-license-crawler@0.2.1, License: BSD-3-Clause
- npm-run-all@4.1.5, License: MIT
- prettier@1.18.2, License: MIT
- protractor@5.4.2, License: MIT
- resize-observer-polyfill@1.5.1, License: MIT
- source-map-explorer@1.8.0, License: Apache-2.0
- ts-node@8.1.0, License: MIT
- tslint@5.16.0, License: Apache-2.0
- tsutils@3.10.0, License: MIT
- webpack-bundle-analyzer@3.3.2, License: MIT