Merge branch 'master' of https://github.com/LinggarM/Priority-Task-Selection-Using-Evolutionary-Programming

Author: LinggarM

README.md

@@ -1,81 +1,92 @@
 # Priority-Task-Selection-Using-Evolutionary-Programming
+A web app that utilizes **Evolutionary Programming** to determine and prioritize tasks for efficient scheduling.
 
-A program to calculate the tasks that we can prioritize to do by determining them using <b>Evolutionary Programming</b> algorithm.
+## About the Project
 
-<!-- TABLE OF CONTENTS -->
-<details open="open">
-  <summary>Table of Contents</summary>
-  <ol>
-    <li><a href="#description">Description</a><li>
-      <a href="#getting-started">Getting Started</a>
-      <ul>
-        <li><a href="#dependencies">Dependencies</a></li>
-        <li><a href="#executing-program">Executing program</a></li>
-      </ul>
-    </li>
-    <li><a href="#screenshots">Screenshots</a></li>
-    <li><a href="#authors">Authors</a></li>
-    <li><a href="#version-history">Version History</a></li>
-    <li><a href="#license">License</a></li>
-    <li><a href="#acknowledgments">Acknowledgments</a></li>
-  </ol>
-</details>
+Priority Task Selection is a program to determine and prioritize tasks from given task options and the total time you have.
 
-## Description
+Sometimes we have a lot of tasks to do but our time is very limited, so we cannot do all the tasks and we have to pick some of the most important tasks from all of the tasks. This program helps you determine and choose which tasks are worth more to do than the others.
 
-This is a program to calculate the tasks that we can prioritize to do by determining them using <b>Evolutionary Programming</b> algorithm. This program is a web-based platform, created with Flask using Python programming language.
+This program uses Evolutionary Programming algorithms to prioritize the most important tasks from a given list of tasks based on their priority scales.
 
-## Getting Started
-
-### Dependencies
-
-* Flask
+## Screenshots
+  Dashboard
+  :-------------------------:
+  ![Screenshots/1.%20Dashboard.png](Screenshots/1.%20Dashboard.png)
+  Example Input Values on Forms
+  ![Screenshots/2.%20Input%20Form.png](Screenshots/2.%20Input%20Form.png)
+  Example Results
+  ![Screenshots/3.%20Result.png](Screenshots/3.%20Result.png)
+
+## Live Demo
+Web App **Priority Task Selection Using Evolutionary Programming**: [http://xxx.xxx](http://xxx.xxx)
+
+## Technology Used
+* HTML
+* CSS
+* Javascript
+* Python
 * Numpy
-
-### Executing program
+* Flask
+* Evolutionary Programming
+
+## Installation
+
+1. Clone this repo
+   ```sh
+   git clone https://github.com/LinggarM/Priority-Task-Selection-Using-Evolutionary-Programming
+   ```
+2. Open the repo folder you have cloned in your PC
+3. Create a virtual environment
+   ```sh
+   python -m venv myenv
+   ```
+4. Activate the virtual environment
+   ```sh
+   myenv/Scripts/activate or "myenv/Scripts/activate" (Windows)
+   myenv/bin/activate (Linux)
+   ```
+5. Install the requirements/ dependencies
+   ```sh
+   pip install -r requirements.txt
+   ```
+
+## Usage (Tutorials)
 
 1. Open CMD in Repository Folder
-2. Run Flask by executing this command :
-```
-python app.py
-```
-or :
-```
-run Flask
-```
-3. Open Given URL (Usually "127.0.0.1:5000")
+2. Run the web app by executing this command :
+   ```
+   python app.py
+   ```
+   or :
+   ```
+   run Flask
+   ```
+3. Open the given URL
+   ```
+   http://127.0.0.1:5000/
+   ```
 4. There are 5 inputs :
 
-    - First input : Total tasks
-    - Second input : All tasks name (Must be sorted according to first input)
-    - Third input : All tasks priority number (You can use 1 until 4, 1 for the lowest prioritize and 4 for the highest prioritize)
-    - Fourth input : All tasks time required (You can use hour time based)
-    - Fifth input : Time you have (Must use the same time based with All tasks time required)
-
-    Inputs example :
-    - First input : 10
-    - Second input : Merapikan tempat tidur, Mencuci piring, Menyuci baju, Menyetrika baju,  Mengepel lantai, Menyiram tanaman, Memandikan kucing, Mengisi bak mandi, Mengurus anak, Merapikan barang-barang
-    - Third input : 4, 3, 3, 2, 2, 1, 1, 1, 3, 2
-    - Fourth input : 1, 2, 3, 2, 2, 1, 1, 1, 3, 2
-    - Fifth input : 8
+    1. The number of tasks (E.g: 10)
+    2. All of the task names (E.g: Food1, Food2, Food3, ..)
+    3. All of the priority scales for each task. Range: 1-5, 1 for the lowest prioritize and 5 for the highest prioritize (E.g: 5, 3, 1)
+    4. All of the task completion times for each task **in hours**. (E.g: 1, 2, 3)
+    5. Total time you have **in hours**. (E.g: 8)
 
-## Screenshots
-
-<img src="images/screenshot.png">
-
-## Authors
-
-* Linggar Maretva Cendani - [Linggar Maretva Cendani](https://linggar.me) - [linggarmc@gmail.com](mailto:linggarmc@gmail.com)
+5. Inputs example :
+    - First input: 10
+    - Second input: Making the bed, Washing the dishes, Washing clothes, Ironing clothes, Mopping the floor, Watering the plants, Bathing the cat, Filling the bathtub, Taking care of the children, Tidying up things
+    - Third input: 4, 3, 3, 2, 2, 1, 1, 1, 3, 2
+    - Fourth input: 1, 2, 3, 2, 2, 1, 1, 1, 3, 2
+    - Fifth input: 8
 
-## Version History
-
-* 0.1
-    * Initial Release
+## Contributors
+* [Linggar Maretva Cendani](https://github.com/LinggarM) - [linggarmc@gmail.com](mailto:linggarmc@gmail.com)
 
 ## License
-
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
 
 ## Acknowledgments
-
 * [Colorlib](https://colorlib.com/) for HTML templates
+* <div style = "color:#FFF">Icons made by <a style = "color:#57b846" href="https://www.freepik.com" title="Freepik">Freepik</a> from <a style = "color:#57b846" href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>