|
1 | 1 | # Lambda Badger |
2 | 2 |
|
| 3 | +## Technologies used |
| 4 | + |
| 5 | +A big thank you to all this powerfull technologies, without them this project could not have existed ! |
| 6 | + |
| 7 | +| Name | Usage |
| 8 | +| ----------------------------------------------------------------------------------- | ------------ |
| 9 | +| [Yarn](https://yarnpkg.com) | A Javascript package manager, safer than npm. |
| 10 | +| [Vue-cli](https://www.npmjs.com/package/vue-cli) | An cli tool built to improve the management of Vue.js project. |
| 11 | +| [Vue.js](https://www.npmjs.com/package/vue) | A reactive framework to build single-page components. |
| 12 | +| [Vue router](https://www.npmjs.com/package/vue-router) | Allows to use Vue.js with the browser URL. |
| 13 | +| [Vuex](https://www.npmjs.com/package/vuex) | A global reactive container of data for Vue.js. |
| 14 | +| [Vue-i18n](https://www.npmjs.com/package/vue-i18n) | Allows to translate all the interface. |
| 15 | +| [Pug](https://www.npmjs.com/package/pug) | A cleaner template than HTML (but translated in HTML) used in components. |
| 16 | +| [Vue-toasted](https://www.npmjs.com/package/vue-toasted) | The internal notification system. |
| 17 | +| [Vuetify](https://www.npmjs.com/package/vuetify) | A material-design graphical system and component supplier, built for Vue.js projects. |
| 18 | +| [PouchDB](https://www.npmjs.com/package/pouchdb) | An in-browser database, built for offline use and compatible with CouchDB replication system. |
| 19 | +| [Cordova](https://www.npmjs.com/package/cordova) | An cli tool to transform web project to mobile-application. |
| 20 | +| [Electron builder](https://www.npmjs.com/package/vue-cli-plugin-electron-builder) | An cli tool to transform web project to desktop application. |
| 21 | + |
| 22 | +## Where to start ? |
| 23 | + |
| 24 | +| Path | Purpose |
| 25 | +| ----------------- | ---------- |
| 26 | +| ./src/locales/ | Translation of the application |
| 27 | +| ./src/App.vue | Global template : header, menu |
| 28 | +| ./src/router.js | Registration of views (= pages) |
| 29 | +| ./src/views/ | Declaration of views (= pages) |
| 30 | +| ./src/components | Declaration of components |
| 31 | +| ./src/store.js | The global container of data, linked to PouchDB |
| 32 | + |
3 | 33 | ## Project setup |
4 | 34 | ``` |
5 | 35 | yarn install |
|
0 commit comments