ag-admin/OpenSlides
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
6de79fc96a
OpenSlides/client/README.md

126 lines
7.1 KiB
Markdown
Raw Normal View History

Add scaffold for angular 6 client - basic client structure - authentication towards OS-server - access REST-Api - webpack proxy for convenient usage - fontawesome - twitter bootstrap 3.3.7 - login example (recreate login page) - routing - template for agenda and motions - dynamic content loading - custom alert component - add auth-guard - checks if a user is logged in and makes correct forwarding - authentification towards OS works - saving the log in information is WIP
2018-06-13 18:34:10 +02:00
# OpenSlides 3 Client
document, restructure, add relations - models get other models from DataStore (Relations) - documentation using Compodoc - rename and restructure - http-interceptor makes all http-objections obsolete - created 'Deserializable model' interface for better mapping of JSON objects - Supports multiple nested objects - No foreign dependancies, no magic - Simple yet efficient deserialize function - arrays of nested objects - created more classes for better OOP AOP
2018-07-12 14:11:31 +02:00
Prototype application for OpenSlides 3.0 (Client).
Currently under constant heavy maintenance.
Add scaffold for angular 6 client - basic client structure - authentication towards OS-server - access REST-Api - webpack proxy for convenient usage - fontawesome - twitter bootstrap 3.3.7 - login example (recreate login page) - routing - template for agenda and motions - dynamic content loading - custom alert component - add auth-guard - checks if a user is logged in and makes correct forwarding - authentification towards OS works - saving the log in information is WIP
2018-06-13 18:34:10 +02:00
document, restructure, add relations - models get other models from DataStore (Relations) - documentation using Compodoc - rename and restructure - http-interceptor makes all http-objections obsolete - created 'Deserializable model' interface for better mapping of JSON objects - Supports multiple nested objects - No foreign dependancies, no magic - Simple yet efficient deserialize function - arrays of nested objects - created more classes for better OOP AOP
2018-07-12 14:11:31 +02:00
## Development Info
Add scaffold for angular 6 client - basic client structure - authentication towards OS-server - access REST-Api - webpack proxy for convenient usage - fontawesome - twitter bootstrap 3.3.7 - login example (recreate login page) - routing - template for agenda and motions - dynamic content loading - custom alert component - add auth-guard - checks if a user is logged in and makes correct forwarding - authentification towards OS works - saving the log in information is WIP
2018-06-13 18:34:10 +02:00
document, restructure, add relations - models get other models from DataStore (Relations) - documentation using Compodoc - rename and restructure - http-interceptor makes all http-objections obsolete - created 'Deserializable model' interface for better mapping of JSON objects - Supports multiple nested objects - No foreign dependancies, no magic - Simple yet efficient deserialize function - arrays of nested objects - created more classes for better OOP AOP
2018-07-12 14:11:31 +02:00
As an Angular project, Angular CLI is highly recommended to create components and services.
See https://angular.io/guide/quickstart for details.
Add scaffold for angular 6 client - basic client structure - authentication towards OS-server - access REST-Api - webpack proxy for convenient usage - fontawesome - twitter bootstrap 3.3.7 - login example (recreate login page) - routing - template for agenda and motions - dynamic content loading - custom alert component - add auth-guard - checks if a user is logged in and makes correct forwarding - authentification towards OS works - saving the log in information is WIP
2018-06-13 18:34:10 +02:00
document, restructure, add relations - models get other models from DataStore (Relations) - documentation using Compodoc - rename and restructure - http-interceptor makes all http-objections obsolete - created 'Deserializable model' interface for better mapping of JSON objects - Supports multiple nested objects - No foreign dependancies, no magic - Simple yet efficient deserialize function - arrays of nested objects - created more classes for better OOP AOP
2018-07-12 14:11:31 +02:00
### 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.
updating the compodoc run command
2018-09-03 12:05:01 +02:00
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.
document, restructure, add relations - models get other models from DataStore (Relations) - documentation using Compodoc - rename and restructure - http-interceptor makes all http-objections obsolete - created 'Deserializable model' interface for better mapping of JSON objects - Supports multiple nested objects - No foreign dependancies, no magic - Simple yet efficient deserialize function - arrays of nested objects - created more classes for better OOP AOP
2018-07-12 14:11:31 +02:00
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.
cleanup and refractor code -combine the features of the two previous commits -add prettier and pretty-quick -more routing and logout button
2018-06-19 16:55:50 +02:00
Start OpenSlides as usual using
`python manage.py start --no-browser --host 0.0.0.0`
Layout and translation fixes
2018-08-03 15:16:40 +02:00
### 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`.
Implements a crawler to find all directly used packages - Holds a 'default' `README.md` with the default content. - Writes down all found packages with links to their repositories.
2019-04-09 10:47:35 +02:00
### Used software
OpenSlides uses the following software or parts of them:
- [@angular/animations@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/cdk@7.3.3](https://github.com/angular/material2), License: MIT
- [@angular/common@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/compiler@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/core@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/forms@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/http@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/material@7.3.3](https://github.com/angular/material2), License: MIT
- [@angular/platform-browser-dynamic@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/platform-browser@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/pwa@0.13.2](https://github.com/angular/angular-cli), License: MIT
- [@angular/router@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/service-worker@7.2.6](https://github.com/angular/angular), License: MIT
- [@ngx-pwa/local-storage@7.4.1](https://github.com/cyrilletuzi/angular-async-local-storage), License: MIT
- [@ngx-translate/core@11.0.1](https://github.com/ngx-translate/core), License: MIT
- [@ngx-translate/http-loader@4.0.0](https://github.com/ngx-translate/http-loader), License: MIT
- [@tinymce/tinymce-angular@3.0.0](https://github.com/tinymce/tinymce-angular), License: Apache-2.0
- [core-js@2.6.5](https://github.com/zloirock/core-js), License: MIT
- [css-element-queries@1.1.1](https://github.com/marcj/css-element-queries), License: MIT
- [exceljs@1.8.0](https://github.com/exceljs/exceljs), License: MIT
- [file-saver@2.0.1](https://github.com/eligrey/FileSaver.js), License: MIT
- [hammerjs@2.0.8](https://github.com/hammerjs/hammer.js), License: MIT
- [material-icon-font@0.1.0](https://github.com//petergng/svgFontCreator), License: ISC
- [ng-pick-datetime@7.0.0](https://github.com/DanielYKPan/date-time-picker), License: MIT
- [ngx-file-drop@5.0.5](https://github.com/georgipeltekov/ngx-file-drop), License: MIT
- [ngx-mat-select-search@1.5.2](https://github.com/bithost-gmbh/ngx-mat-select-search), License: MIT
- [ngx-papaparse@3.0.2](https://github.com/alberthaff/ngx-papaparse), License: MIT
- [pdfmake@0.1.53](https://github.com/bpampuch/pdfmake), License: MIT
- [po2json@1.0.0-alpha](https://github.com/mikeedwards/po2json), License: GNU Library General Public License
- [rxjs@6.4.0](https://github.com/reactivex/rxjs), License: Apache-2.0
- [tinymce@4.9.2](https://github.com/tinymce/tinymce-dist), License: LGPL-2.1
- [uuid@3.3.2](https://github.com/kelektiv/node-uuid), License: MIT
- [zone.js@0.8.29](https://github.com/angular/zone.js), License: MIT
- [@angular-devkit/build-angular@0.13.2](https://github.com/angular/angular-cli), License: MIT
- [@angular/cli@7.3.2](https://github.com/angular/angular-cli), License: MIT
- [@angular/compiler-cli@7.2.6](https://github.com/angular/angular), License: MIT
- [@angular/language-service@7.2.6](https://github.com/angular/angular), License: MIT
- [@biesbjerg/ngx-translate-extract@2.3.4](https://github.com/biesbjerg/ngx-translate-extract), License: MIT
- [@compodoc/compodoc@1.1.8](https://github.com/compodoc/compodoc), License: MIT
- [@types/jasmine@3.3.9](https://github.com/DefinitelyTyped/DefinitelyTyped), License: MIT
- [@types/jasminewd2@2.0.6](https://github.com/DefinitelyTyped/DefinitelyTyped), License: MIT
- [@types/node@11.9.4](https://github.com/DefinitelyTyped/DefinitelyTyped), License: MIT
- [@types/yargs@12.0.9](https://github.com/DefinitelyTyped/DefinitelyTyped), License: MIT
- [codelyzer@4.5.0](https://github.com/mgechev/codelyzer), License: MIT
- [fs@0.0.1-security](https://github.com/npm/security-holder), License: ISC
- [husky@1.3.1](https://github.com/typicode/husky), License: MIT
- [jasmine-core@3.3.0](https://github.com/jasmine/jasmine), License: MIT
- [jasmine-spec-reporter@4.2.1](https://github.com/bcaudan/jasmine-spec-reporter), License: Apache-2.0
- [karma-chrome-launcher@2.2.0](https://github.com/karma-runner/karma-chrome-launcher), License: MIT
- [karma-coverage-istanbul-reporter@2.0.5](https://github.com/mattlewis92/karma-coverage-istanbul-reporter), License: MIT
- [karma-jasmine-html-reporter@1.4.0](https://github.com/dfederm/karma-jasmine-html-reporter), License: MIT
- [karma-jasmine@2.0.1](https://github.com/karma-runner/karma-jasmine), License: MIT
- [karma@4.0.0](https://github.com/karma-runner/karma), License: MIT
- [npm-license-crawler@0.2.1](https://github.com/mwittig/npm-license-crawler), License: BSD-3-Clause
- [npm-run-all@4.1.5](https://github.com/mysticatea/npm-run-all), License: MIT
- [prettier@1.17.0](https://github.com/prettier/prettier), License: MIT
- [protractor@5.4.2](https://github.com/angular/protractor), License: MIT
- [source-map-explorer@1.7.0](https://github.com/danvk/source-map-explorer), License: Apache-2.0
- [terser@3.16.1](https://github.com/fabiosantoscode/terser), License: BSD-2-Clause
- [ts-node@8.0.2](https://github.com/TypeStrong/ts-node), License: MIT
- [tslint@5.12.1](https://github.com/palantir/tslint), License: Apache-2.0
- [tsutils@3.8.0](https://github.com/ajafff/tsutils), License: MIT
- [typescript@3.2.4](https://github.com/Microsoft/TypeScript), License: Apache-2.0
- [webpack-bundle-analyzer@3.0.4](https://github.com/webpack-contrib/webpack-bundle-analyzer), License: MIT
Reference in New Issue Copy Permalink