alberanid/ibt2
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

add demo to the documentation

Browse source
This commit is contained in:
Davide Alberani 2017-01-21 16:47:07 +01:00
parent 97d45558f5
commit 20ef37db84
2 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -11,6 +11,10 @@ Basic workflow:
It's recommended to login with username '''admin''' and password '''ibt2''', go to your personal page and change the password, if you've just installed ibt2.
# Demo
See [http://ibt2.ismito.it:3002/](http://ibt2.ismito.it:3002/)
## Install, run, develop and debug
To install it:
@ -38,7 +42,7 @@ npm run build
npm run server
```
Now you can **point your browser to http://localhost:3000/** (that's the server for production)
Now you can **point your browser to [http://localhost:3000/](http://localhost:3000/)** (that's the server for production)
If you want, you can **share a link to a specific day**, specifying it in the *yyyy-mm-dd* format, like: http://localhost:3000/#/day/2017-01-20
@ -59,7 +63,7 @@ npm run dev
python ./tests/ibt2_tests.py
```
Your browser will automatically open http://localhost:8080/ (that's the server for development)
Your browser will automatically open [http://localhost:8080/](http://localhost:8080/) (that's the server for development)
Development
@ -73,7 +77,7 @@ Technological stack
- [VueJS](https://vuejs.org/) for the webApp
- [Vue Material](https://vuematerial.github.io/) for the UI components
- [vue Datepicker](https://github.com/charliekassel/vuejs-datepicker) for the datepicker
- [Vue Datepicker](https://github.com/charliekassel/vuejs-datepicker) for the datepicker
- [Tornado web](http://www.tornadoweb.org/) as web server
- [MongoDB](https://www.mongodb.org/) to store the data

3
docs/DEVELOPMENT.md
View file

@ -91,6 +91,9 @@ not-so-FAQs
- **A:** yes, probably in the near future.
- **Q:** *.vue* files? What's that?
- **A:** Vue [single-file components](https://vuejs.org/v2/guide/single-file-components.html); a [webpack](https://webpack.js.org/) plugin will take care of translating them into stuff that can be digested by a browser.
- **Q:** I've added a new path to the backend, and now the hot reload server is not working!!1!!
- **A:** that's not even a question. Anyway, add the path to dev.proxyTable in *config/index.js*