59 lines
4.6 KiB
Markdown
59 lines
4.6 KiB
Markdown
## LIBRARIES USED
|
||
|
||
| status | lib name | usage |
|
||
| :-------------: | -------------------------------------------------------------- | --------------------------------------------------------- |
|
||
| | [axios](https://github.com/axios/axios) | http client |
|
||
| | [bulma](https://bulma.io/) | CSS framework |
|
||
| | [chart.js](https://www.chartjs.org/) | PrimeNG solution for graphs. (Chart.js installs MomentJS) |
|
||
| | [compodoc](https://compodoc.app/) | Generate technic documentation |
|
||
| | ESlint, Prettier, Lint-staged | Format & lint code |
|
||
| | [fork-awesome](https://forkaweso.me) | Icons collection |
|
||
| | [fullcalendar](https://fullcalendar.io/docs/initialize-es6) | PrimeNG solution to manage & display calendars |
|
||
| | [husky](https://www.npmjs.com/package/husky) | Hook actions on commit |
|
||
| | [jest](https://jestjs.io/) | test engine |
|
||
| | [json-server](https://www.npmjs.com/package/json-server) | local server for mocking data backend |
|
||
| removed | [locale-enum](https://www.npmjs.com/package/locale-enum) | enum of all locales |
|
||
| | [momentJS](https://momentjs.com/) | manipulate dates. (chartJS’s dependency) |
|
||
| to be installed | [ng2-charts](https://valor-software.com/ng2-charts/) | Manipulate graphs along with chart.js |
|
||
| | [ngx-clipboard](https://www.npmjs.com/package/ngx-clipboard) | Handle clipboard |
|
||
| | [ngx-markdown](https://www.npmjs.com/package/ngx-markdown) | markdown parser |
|
||
| | [ngx-webstorage](https://www.npmjs.com/package/ngx-webstorage) | handle localStorage & webStorage |
|
||
| | [primeNG](https://www.primefaces.org/primeng/) | UI components collection |
|
||
| | [quill](https://www.npmjs.com/package/quill) | powerful rich text editor. WYSIWYG. |
|
||
| to be installed | [short-uuid](https://www.npmjs.com/package/short-uuid) | generate uuid |
|
||
| removed | [storybook](https://storybook.js.org/) | StyleGuide UI |
|
||
| | [ts-mockito](https://www.npmjs.com/package/ts-mockito) | Mocks for testing. |
|
||
| to be removed | [uuid](https://www.npmjs.com/package/uuid) | generate uuid |
|
||
|
||
---
|
||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.2.1.
|
||
# Framadate
|
||
|
||
A libre polling software make by contributors around the French association Framasoft.
|
||
|
||
## Development server
|
||
|
||
Run `yarn 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).
|
||
|
||
## Running end-to-end tests
|
||
|
||
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
|
||
|
||
## Further help
|
||
|
||
Before using ng for the first time in this project, use `npm i` to install needed npm modules.
|
||
|
||
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).
|