diff --git a/vue_hissikutsu/README.md b/vue_hissikutsu/README.md index 71f64ec1d03a189d319ed2fab40f78fa72d318f9..a8bda905159429c4459654c1725515b0539d4633 100644 --- a/vue_hissikutsu/README.md +++ b/vue_hissikutsu/README.md @@ -1,4 +1,13 @@ -# hissikutsu_jest +# Elevator call application using KONE API +This small project was made as part of soveltava projekti course of faculty of computer science in Univeristy of Turku. +The main goal of the course was to get familiar with common software development tools, processes and practices. +The main focues areas where as follows: setting up a CI/CD pipeline, setting up and writing unit tests, +get more practices with git version controlling and the common practices around it. + +As a side product we made this small application that allows you to make an elevator call from a web browser. +For that you need to register in dev.kone.com and create your self a set of API keys. The application asks +the keys when you start. Feel free to test. There are plenty of possibilities that you can explore around +Elevator and Service Robot APIs. This is fun stuff! ## Project setup ``` @@ -15,12 +24,12 @@ npm run serve npm run build ``` -### Run your unit tests +### Run your unit tests (to be improved) ``` npm run test:unit ``` -### Run your end-to-end tests +### Run your end-to-end tests (no end to end test implemented) ``` npm run test:e2e ``` @@ -32,3 +41,5 @@ npm run lint ### Customize configuration See [Configuration Reference](https://cli.vuejs.org/config/). + +### Documentation is still missing. I have plans to study more on how to automate the documentation creation process.