v0.3 FAVOR RELEASE 📌

📋 Table of Contents

• Introduction
• Quickstart
• Site-List
• Feature-List
• Change-Log
• Documentation
• Testing
  • Testing-Documents
  • Known Issues
• Contributing
• Build with
• Links
• License

▶️ Introduction

FAVOR is a project to improve family-life by helping planning tasks and structure everyday-life.
Developed with Materialize.

This Relase (v0.3) isn't a final release and also not a online website which can be visited.

🚀 Quickstart:

• Clone v0.3 of FAVOR

  $ git clone https://github.com/philipp323/FAVOR.git
  $ git checkout tags/v0.3
  

• Start JSON-"Server"
  (Install Instructions: JSON-Server)

  $ json server --watch favor.json
    \{^_^}/ hi!
    Loading favor.json
    DONE
    
    Resources
    http://localhost:3000/family
    http://localhost:3000/member
    http://localhost:3000/task
  

• Open "index.html" file

• Info: Manual

Just for design and animation reviewing, the website is already reachable online.
🚧 Notice: No database connection given!

🔎 Site-List:

List of all reachable HTML-Files

• index.html (Frontpage with Product Introduction)
• about.html (Page which shows us and our school)
• creation.html (Page for the Family-Group-Creation-Process)
• app.html (Page with Features and Functionalities, such as the Task-Create-Menu)

📝 Feature-List:

• Register (Family-Group)
  • Saves data to JSON-File
  • Table: "family"
• Family-Member-Creation
  • Saves data to JSON-File
  • Table: "member"
• Task-Creation
  • Saves data to JSON-File
  • Table: "task"
• Family-Overview
  • Gives information about the Family-Group
• Remove Member
  • In the Family-Overview
• Logout
  • Clears Local-Data

💾 Change-Log:

Reachable in the Footer of our Website -> "Website-History"

📄 Documentation:

Project Documents:

• System Specification
• Project Proposal
• Manual

🔬 Testing:

Browser: FireFox Quantum 60.0.2

Testing-Documents:

• Test-Specification
• Test-Protocol
• Test-Report

Known Issues:

• Error in Console when POST/DELETE a element (still works)
• After task-creation site is needed to be reloaded
• Problem with mobile-view in app.html

📈 Contributing:

Developers:

• Philipp Auinger
• Alexander Walter

School: HTL Leonding

More about us and our school on our website

To see the contributions to master, of each developer, check out this graph.

🔧 Build with:

• Materialize
• jQuery
• HeroPatterns
• StackOverflow
• HTML5
• CSS
• JavaScript

🔗 Links:

• FAVOR
• Materialize
  • Github
• JSON-Server

🔒 License:

MIT License

Copyright (c) 2018 Philipp A.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.