diff --git a/README.md b/README.md index 13b0b84e6c4487b58787a41017a2d130b8d39f51..15c6a490ca470404469e74fd93c083dc6f1c4738 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,13 @@ -# Arsnova Angular Frontend +# ARSnova lite -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.7.2. +This is the new Frontend for the Audience Response System ARSnova and is currently in beta. -## Development server +The project aims to provide a new experience with ARS systems and breaks with conventions introduced by arsnova-mobile. You can head over to [arsnova-lite](https://arsnova-lite.mni.thm.de/) to see it in action. -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +## Documentation -## Code scaffolding +* [For developers](development.md) -Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. +## Credits -## Build - -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build. - -## Running unit tests - -Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). - -## Running end-to-end tests - -Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). - -## Further help - -To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). - -## Wiki - -For further project documentation, see [Wiki](https://git.thm.de/swtp-block-ws17/arsnova-angular-frontend/wikis/home) +ARSnova is powered by Technische Hochschule Mittelhessen - University of Applied Sciences. diff --git a/development.md b/development.md new file mode 100644 index 0000000000000000000000000000000000000000..427f0028e4ed20dcb73f5a5495bef825b7f63200 --- /dev/null +++ b/development.md @@ -0,0 +1,35 @@ +# ARSnova lite development + +This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.7.2. + +## Prerequisite + +Clone the repository and setup git. +You also need the arsnova-backend running in version 3+ (`master` branch). + +Install all dependencies with `npm install`. + +## CI Pipeline + +In order to guarantee code quality a [linter ](https://palantir.github.io/tslint/). +You can check your code locally with: `node_modules/tslint/bin/tslint -p ./tsconfig.json -c ./tslint.json --project`. + +## 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. + +## Code scaffolding + +Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. + +## Build + +Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build. + +## Running unit tests + +Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). + +## Wiki + +For further project documentation, see [Wiki](https://git.thm.de/arsnova/arsnova-lite/wikis/home)