funky-framadate-front/README.md

4.6 KiB
Raw Blame History

LIBRARIES USED

status lib name usage
axios http client
bulma CSS framework
chart.js PrimeNG solution for graphs. (Chart.js installs MomentJS)
compodoc Generate technic documentation
ESlint, Prettier, Lint-staged Format & lint code
fork-awesome Icons collection
fullcalendar PrimeNG solution to manage & display calendars
husky Hook actions on commit
jest test engine
json-server local server for mocking data backend
removed locale-enum enum of all locales
momentJS manipulate dates. (chartJSs dependency)
to be installed ng2-charts Manipulate graphs along with chart.js
ngx-clipboard Handle clipboard
ngx-markdown markdown parser
ngx-webstorage handle localStorage & webStorage
primeNG UI components collection
quill powerful rich text editor. WYSIWYG.
to be installed short-uuid generate uuid
removed storybook StyleGuide UI
ts-mockito Mocks for testing.
to be removed uuid generate uuid

This project was generated with 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.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

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.