User Manual - oronsa/shoulder2shoulder GitHub Wiki
User Manual
Table of Content
- Getting Started
- Sign-Up Process
- Log-In Process
- Forgot Password
- Using User Dashboard
- Admin Home
- User Home
- Admin Options
- Special Functionallity For Super Admin
- User Options
- Add report
- View Reports
- Add bill
- View Bills
- Edit Details
Getting Started
Accounting Shoulder is a Web Based system aimed to assist underprivileged families improve their finance status, within the website you will find a variety of options that will make sure of that. Some of the features are: Messaging system, requesting finance reports with different views and time ranges, reporting daily expenses, and in the background allowing admins to monitor their proteges, which will increase the transparency.
Sign-Up Process
Each user will receive a security Token from an admin (with Super permissions) which will act as a security key,to assure users control. All the personal data will be filled in the sign up form.
Log-In Process
By a user name and a password, as well as "Forgot password" mechanism
##Forgot Password After validation with the DB about the email address, after that message been sent to user with temporary token that in stage 2 of recovery is required to continue with the process
##Stage One
##Stage Tow
Using User Dashboard
A navigation bar with buttons which will navigate the users through their options in the application Different users will get different views in the website
##Admin Home https://raw.githubusercontent.com/oronsa/shoulder2shoulder/master/Doc/Images/user%20menual%20photos/adminHome.png
##Admin Options Admin that is not a "super admin" can only see the families that he leads, he also can see their monthly balance or any other month in range of year forward and year backwards (like a user). https://raw.githubusercontent.com/oronsa/shoulder2shoulder/master/Doc/Images/user%20menual%20photos/userViewForAdmin.png
##Special Functionallity For Super Admin Users that has super admin permission can do more actions, like removing user from system or send key to new user end even connect between guide and family, the last important addition that the super admin has is the ability to see details about all the family in the organization
###User Options Regular user can see his monthly balance in his home page and either able to see other months. Additional functionality for user is add bills for his expenses and also filling reports about his revenues. The summaries of accounts and reports can be seen as mentioned above on the home page or specific pages for more detailed and additional information about bills and reports by dates
##Add report: https://raw.githubusercontent.com/oronsa/shoulder2shoulder/master/Doc/Images/user%20menual%20photos/monthlyReport.png
##View Reports: https://raw.githubusercontent.com/oronsa/shoulder2shoulder/master/Doc/Images/user%20menual%20photos/reportsView.png
##Viwe bills: https://raw.githubusercontent.com/oronsa/shoulder2shoulder/master/Doc/Images/user%20menual%20photos/viewBills.png
###Edit Details All the users be able to edit their details, the edit need to pass the same validation like in sign-up form but here user can decide which detail he want change, the ability to change email and password require to pass full validation about the old details and the new. https://raw.githubusercontent.com/oronsa/shoulder2shoulder/master/Doc/Images/user%20menual%20photos/editProfilePage.png
Contacting Team Leader
in any case of problem or bugs, our team is always at your service at [email protected] You can also find our contact information in the website.
Security
The website manage separate page access control by server side sessions which will redirect the users to their next state by their role and show locally the appropriate navigation bar
How to Use
The product will suitable for all devices, which will run as a web application with a URL.[Accounting Shoulder] (http://accountingshoulder.azurewebsites.net/)
FAQ: General
-
What do I need to do in order to use the website? Nothing, the website is ready to use without any add-ons from any websites browser
-
How do I Sign Up? Find the label "Sign Up" in the navigation bar, just make sure that you received your Token in advanced
-
How do I get my Token? Ask for your Token from your administrator in the organization
-
How do I retrieve my password? In the Log-In page you will be able to press the link "Forgot Password?" and follow the instructions to do so (mention above)