Browse Source

change documentation

master
pvincent 4 years ago
parent
commit
72b4c72efa
  1. 4
      LICENSE
  2. 19
      README.md
  3. 7
      TODO.md

4
LICENSE

@ -1,5 +1,5 @@
Vapara-vue3,
Copyright (C) 2021 Prestalibre.re
AGPL-3.0-or-later
=================
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as

19
README.md

@ -1,9 +1,9 @@
VAPARA-VUE3
PROTOVUE
===========
Vapara is frontend application for online shop.
Based on Vue3, it relies on Dolibarr's API calls.
`npm` version 7 required!
Protovue is a frontend application for online shopping.
Based on Vue3, it relies on Dolibarr's API calls or fake data.
`npm 7` required!
HOW TO RUN
----------
@ -13,6 +13,15 @@ npm ci
npm run dev
```
HOW TO DEBUG
------------
```
# open codium IDE
codium .
# , then launch Debug in Firefox (or Chromium)
```
HOW TO DEPLOY
-------------
@ -23,6 +32,8 @@ npm build
npm preview # optional
```
MORE INFORMATION
----------------

7
TODO.md

@ -1,7 +1,8 @@
TODO
====
## ARCHITECTURE
ARCHITECTURE
------------
* [x] vite + vue3 (up-to-date)
* [x] typescript suppport
@ -17,7 +18,8 @@ TODO
* [ ] axios
## FEATURES
FEATURES
--------
* [ ] grab products, categories and images from Dolibarr's API
* [ ] parallelization
@ -25,4 +27,3 @@ TODO
* [ ] cache for images
* [ ] login/logout
* [ ] basket
Loading…
Cancel
Save