Coder Social home page Coder Social logo

aliencaocao / aredro Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 68.53 MB

A simple ordering app for HCI Student Council welfare

Home Page: https://sites.google.com/view/aredro/home

License: Apache License 2.0

HTML 83.34% CSS 2.11% JavaScript 0.18% PHP 14.37%

aredro's Introduction

Aredro

A simple ordering app for HCI Student Council welfare

☛Aredro Public Beta Notes☚

Last Updated: 15 September 2017 18.33

Latest Aredro App Version: V 1.0.0 [Stable]

☞Please read this document before using Aredro.☜

Welcome to Aredro Public Beta! We are the development team of Aredro. Here is a detailed guide on participating in Aredro Public Beta. Full clickable index below :)

Terms & Conditions (Must-read)

This document MUST be distributed together with the app (only during beta).

You may redistribute the app in any non-commercial form, but you may NOT change any of the source code and redistribute the app again. The source code is made public (refer to FAQ Q13, 14), but if you would like to change the code and redistribute the app, you MUST obtain a written consent from the developers (contact at bottom of the official website). If not, we will report you as plagiarism.

This document will be updated whenever needed, but the development team will not inform the testers about the changes in the document. Please keep an eye on this document whenever possible.

Aredro is still a developing app, which means it could be unstable sometimes. Although the team has made their best effort to ensure the stability of releases, there could still be incidents such as app crashing/not responding, unable to work properly under some circumstances etc. There may also be bugs/glitches. Refer to “Report Bug” section to learn how to report such bugs.

By installing Aredro Beta, you must acknowledge these risks. However, please be assured that the app will not charge you in any form, and will not damage your device. It also does not contain any malware/harmful software (only applies to downloads from our official website.)

ALL testers will be credited in our website, under /About/Testing. The tester’s name will not be displayed unless he/she agrees to. All testers will need to provide the development team a form of contact when reporting bugs/making suggestions so we can learn more from the testers if necessary. Troll/spam feedbacks/reports will NOT be entertained and will be reported.

The development team reserves the right to terminate anyone’s participation in Aredro Public Beta if his/her disobeys the T & Cs above.


System Requirements

  • Android Version Requirements: How to check Android Version?

    • Phones/Tablets running Android 5.0 and above

    NOTE: For users with Android version 2.3 to 3.2, please use the classic version. The functions are the same, but UI is less appealing.

    For users with Android version 4.0 to 4.4, please use version 0.3.4. Version 0.4.0 and above only supports Android 5.0 and above systems.

  • At least 100MB available RAM, 1GB total RAM

  • Storage Space Requirements:

    • For Android 5.0 and above systems: 20 MB
    • For Android 4.0 to 4.4 systems: 11 MB
  • Internet connection (Aredro uses VERY LITTLE bandwidth) Refer to FAQ Q7

  • Google Chrome (should be preinstalled on all Android® devices)


Reporting bugs

You may submit one-sentence-long bug-reports by commenting right HERE.

If you would like to provide more information on the bug (hugely appreciated), you may fill in the feedback form HERE.

Note that the reported bugs will be listed below. Please do not report bugs that are already listed. The bug will be highlighted in green once it is fixed.

We may contact you for more details about the bug you have reported. Thank you for providing as much detail as you can so that we can troubleshoot faster.

We will **not **inform you individually about the status (fixed, fixing) of the bug(s) you have reported. Instead, please look out for the reported bug list or change log for bug fixes.


Making suggestions/feedbacks

You may make one-sentence-long suggestions by commenting right HERE.

If you would like to make a more detailed one, please kindly fill in this feedback form HERE.

Received suggestions will be listed below. Please do not suggest the same point.

We value EVERY suggestion we receive, and promise to implement these suggestions if possible and reasonable. All those whose suggestions are implemented will be specially credited on our website (his/her name will be made public unless he/she choose to not).

We will reply to suggestions if necessary, for other suggesters to read. Reply is right below the suggestion itself.


Known bugs/glitches

**Note: **This is the list of all known bugs/glitches/issues that affect the normal usage and functions of the app. It does not include suggestions for improvements that do not affect the functions of Aredro. (For received suggestions, click here:)

Before reporting: Please ensure that you have the lastest version of Aredro, as we might have already fixed that bug you found in a new version :)

Each and every received bug report will be credited* right after the bug itself.

The tag [DEV] means this bug is found by a developer. Bug(s) highlighted in green means the bug has been fixed.

*Some of the bug reports may be credited as “anonymous” as he/she chose to not to reveal his/her identity.

  1. App crashes when trying to open the register screen. This bug only occurs on some systems, including most Android 5 systems. (Reported by [DEV]Cao Yuxuan)
  2. When submission failed in “add items” page, the notification will show number “0” instead of the error message. (Reported by [DEV]Cao Yuxuan)
  3. The time shown in the “check items” and “check orders” page will be UTC time, which is 8 hours later than SG time. We cannot fix this bug so far. (Reported by Ma Xundong/Class 1.2 CHS)
  4. There is a black dot (full-stop) appearing above table in “Check Items” page. (Reported by [DEV] Cao Yuxuan)
  5. On some devices, the buttons in the app will be white coloured instead of black and hence the white text in it cannot be seen. If on your device the buttons are white-coloured, please report it to us here. (Reported by [DEV] Aloysius Lam)
  6. The very left edge of the screen is not responsive in the app. It is due to the new-added sidebar. We apologise that we so far cannot fix this issue. [Reported by [DEV] Cao Yuxuan)

Received suggestions

**Note: **This is the list of all received suggestions. It does not include reported bugs that will affect the normal usage of Aredro. (For list of bugs, click here:)

Each and every received suggestions will be credited* right after the suggestion itself.

*Some of the suggestions may be credited as “anonymous” as he/she chose to not to reveal his/her identity.

  1. Improve the User Interface Design (Suggested by anonymous)

    Reply from dev: we are already trying our best to improve UI, but please understand the limits of a sec 1 group and a very basic programming platform.

  2. Move help buttons, improve colour contrast, remove redundant colours, sanitise database inputs (Suggested by anonymous)

Reply from dev: We have sent you an email addressing the feedbacks. Most of your suggestions will be accepted.

  1. Allow the user to remember their username. (Suggested by Yu Ke Mi & Ian Lee from 1A1, HCI)

Reply from dev: Implemented in version 0.4.1.


FAQ (Frequently asked questions)

Q1. How do I check the android version for my device?

A1. Open “Settings”, find “About device” (usually at the bottom of the list), click, find “Android Version” or a similar list item. The number displayed there (x.y or x.y.z) is the Android version number.

Q2. How do I know that I have gotten the latest version of Aredro?

A2. Get the installed version number of Aredro (refer to Q3), go to official download page, check if the installed version number matches the displayed “latest version” number in the website.

Q3. How do I know the current installed version of Aredro?

A3. 3 ways. Method 3 only works for some systems.

  1. 👍Open Aredro, click “about” at the bottom of the login screen. The version number is shown within a grey strip on top. The number behind “App Version-” is the installed app version, not the one behind “build”.
  2. Open “Settings”, find “App”, click and opens up a list of installed apps, find Aredro, click into the detail page. The version number is right below the App logo & name at the top.
  3. Find Aredro icon on your screen (clicking which will open Aredro), press and hold till a menu appears on top of the screen. Find the menu item “App Info” and drag the app into it. It will open up the detail of Aredro, the version number is right below the App logo & name at the top.

Q4. There is a new version available, so how do I update the app?

A4. Go to official download page, click on the link behind “Latest version” at top of the web page. You will be redirected to the APK file shared on Google Drive. Click download. After downloading, open the downloaded APK file and follow the instruction on screen. Please ONLY download from our official website!

Q5. What is an APK file?

A5. An APK file (Application Package) is an installer for Android® apps. Hence it can only be opened on Android® devices. To install the app from a APK file, simply click to open it and follow instructions on screen. After installing the app, you may delete the APK file to free up storage space as it will not be needed anymore.

Q6. How much data will Aredro use if I turn on mobile data?

A6. VERY LITTLE. Result of testing: Register+Login+Check Item+Place an Order uses a total of at most 50KB of data.

*(1 GB=1024 MB; 1 MB=1024 KB ∴50 KB=4.76837158203125e-5% GB:)

Q7. Do I have to use Aredro in school for ordering?

A7. Of course you do not have to! Although Aredro serves HCI for now, it is NOT limited to HCI wi-fi, unlike iTAP attendance taking app (NO OFFENCE!). You may use ALL functions of Aredro at any where, as long as there is internet access.

Q8. What if I encountered a problem while using Aredro but not sure if it is a bug or caused by my incorrect way of using Aredro?

A8. No worry! Fill in the feedback form and we will get back to you if it is not a bug with Aredro. If it is a bug, we will list it in the “Known bugs list” and will try to fix it. Choose category “I need help” when filling up the feedback form.

Q9. I am a councillor. How do I obtain the Manager Pin to register as a Manager?

A9. You should have already known the Manager Pin when we release the app to you. If not, drop us a short email stating your name & class. Once we confirm that you are a councillor or person-in-charge, we will email you the Manager Pin.

Q10. If I want to write an email to the development team, do I have to take note of anything?

A10. Include your name & your app version number (refer to Q3) **if **it is an issue with the app. Write to us at [email protected]. Feel free to use any email account you like (not necessarily school gmail) as long as we can get back to you if needed. Trollers/spammers will be blacklisted and reported.

Q11. Do I have to be serious about the orders?

A11. **No. **Due to time limit, you do not have to pay for thing you have ordered. However, please do NOT spam, or you will be banned from future testing.

**Q12. **Why cannot I find and download Aredro from Play Store?

A12. We are very sorry about that, but for it to be on Play Store, we need to pay $ to apply and wait for a rather long time. If the app gets more popular, we will consider uploading it onto Play Store.

Q13. What is the Source Code?

A13. It is literally the code of the app. It not only includes the code of the app itself, but also other parts that are crucial for the app to function but is not seen when using the app (e.g. backend database). To obtain the source code basically means to know how did we developed the app and how does it works, from the code’s perspective. However, T&Cs apply if you would like to obtain Source Code.

**Q14. **How can I obtain the Source Code for Aredro?

A14. Go to official source code web page and follow the instructions on it.

Please note that T&Cs apply as mentioned in Terms & Conditions section.

Q15. Is there an iOS version of Aredro for iPhone users?

A15. Not yet. Due to our limited time and development skill, we only managed to develop the Android® version. If we are continuing this project next year, we may develop the iOS version as well. Stay tuned!

Q16. My device alerts me that the file may damage my device when I am downloading from the given website. So is it safe at all?

A16. YES. It is completely normal for your device to alert you as such. The file you are downloading is an APK file (refer to Q5), and it is straight from a webpage, hence there could be chances when you download a virus. However, please be assured that the files on our website does not contain any harmful software.

If you would like to suggest a FAQ entry, feel free to feedback to us HERE.

If you have any other questions, feel free to drop us an email (refer to FAQ Q10) and we will reply if needed.


Acknowledgments (Must-read)

This document “Aredro Public Beta Notes” is FULLY written by the development team. All information provided is up-to-date and we will make necessary changes whenever needed. Hence, this document will be edited after it has been distributed (especially the “known bugs” section). So do check this document whenever possible. The development team will not inform the testers about the changes in the document.

**NO ONE IS TO COPY ANY PART OF THIS DOCUMENT AND USE IT IN ANY FORM WITHOUT THE DEVELOPER'S’ WRITTEN CONSENT. THOSE WHO CAUGHT DOING SO WILL BE REPORTED AS PLAGIARISM. **

Aredro Development Team RESERVES ALL RIGHTS.


More information?

For other information, kindly refer to our official website.

© Aredro Development Team, Hwa Chong Institution

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.