From f038baebeaaf07b7bd8f50be29d11a899247ca0f Mon Sep 17 00:00:00 2001 From: Deepak Ramachandran <42649107+ProgrammingMuffin@users.noreply.github.com> Date: Sat, 23 Oct 2021 23:54:49 +0530 Subject: [PATCH 1/4] Add usage gif screenshots --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7cd51b..cae405a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -## TaskManager +## About TaskManager TaskManager is an application that allows you to create lists and add tasks to that list which you can then mark as done when it's done. It is written primarily for demonstrating microservice architecture and kubernetes. It can be used as a _sample or reference_ project for building similar projects. The backend is written in *Python* using the *Flask* lightweight web framework. It uses *Flask-SQLAlchemy* for the ORM and it uses *Alembic* migration tool which is built on top of SQLAlchemy. The UI is written in *Vue.js* and the state management is handled using *Vuex*. The router is handled using *vue-router*. + +## Screenshots + +- Creating a list + +[![create_list.gif](https://s1.gifyu.com/images/create_list.gif)](https://gifyu.com/image/eIPA) + +- Deleting a list + +[![delete_list.gif](https://s1.gifyu.com/images/delete_list.gif)](https://gifyu.com/image/eIXI) From 7ad74b29dcbed031e9c3d07b3e7c14b7d8d48b41 Mon Sep 17 00:00:00 2001 From: Deepak Ramachandran <42649107+ProgrammingMuffin@users.noreply.github.com> Date: Sun, 24 Oct 2021 11:05:57 +0530 Subject: [PATCH 2/4] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index cae405a..f6d6c88 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,17 @@ TaskManager is an application that allows you to create lists and add tasks to t - Deleting a list [![delete_list.gif](https://s1.gifyu.com/images/delete_list.gif)](https://gifyu.com/image/eIXI) + +## Installation + +- Install docker if you don't already have it. +- Install minikube if you don't already have it. +- run ```minikube start``` to start the cluster +- run ```minikube ip``` to get the node's IP address +- open `/etc/hosts` file and add an entry ```{minikube_ip} taskmanagerbackend```. Replace minikube_ip with the ip we found with ```inikube ip``` command +- clone the repository +- run ```sh deploy.sh``` and it should deploy the application to minikube + +## If the installation steps didn't work + +Please create an issue on the repository From 7989d015637789e35337826e4c4f0868d40aabf8 Mon Sep 17 00:00:00 2001 From: Deepak Ramachandran <42649107+ProgrammingMuffin@users.noreply.github.com> Date: Sun, 24 Oct 2021 11:07:00 +0530 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f6d6c88..f5b7b8e 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ TaskManager is an application that allows you to create lists and add tasks to t - Install minikube if you don't already have it. - run ```minikube start``` to start the cluster - run ```minikube ip``` to get the node's IP address -- open `/etc/hosts` file and add an entry ```{minikube_ip} taskmanagerbackend```. Replace minikube_ip with the ip we found with ```inikube ip``` command +- open `/etc/hosts` file and add an entry ```{minikube_ip} taskmanagerbackend```. Replace `{minikube_ip}` with the ip we found with ```minikube ip``` command - clone the repository - run ```sh deploy.sh``` and it should deploy the application to minikube From a7e5af79d81e05e814fc60f7ae1ba51c0bf3bfc0 Mon Sep 17 00:00:00 2001 From: Deepak Ramachandran <42649107+ProgrammingMuffin@users.noreply.github.com> Date: Sun, 24 Oct 2021 11:08:33 +0530 Subject: [PATCH 4/4] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f5b7b8e..77cff1e 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ TaskManager is an application that allows you to create lists and add tasks to t - open `/etc/hosts` file and add an entry ```{minikube_ip} taskmanagerbackend```. Replace `{minikube_ip}` with the ip we found with ```minikube ip``` command - clone the repository - run ```sh deploy.sh``` and it should deploy the application to minikube +- to access the application, go to `http://taskmanagerbackend:8080` ## If the installation steps didn't work