User Manual

User Manual

Table of Content

1. Getting Started

• Sign-In
• Log-In
• Using User Dashboard
• Contacting Team Leader

2. How to Use
3. Troubleshooting
4. FAQ: General
5. FAQ: Operational

• How to install the server
• How to run tasks and tests
• How to run the server

Getting Started

ProjectHands is a Web Based system aimed to automate the management of charity Projects that includes managers,volunteers and people who is being helped , To save the time and get better performance of what is being done.

To start please check the Sign-In Process below.

Sign-In Process

To Sign-In please open the following URL:

http://projecthands.azurewebsites.net/signup

1. Find join us in the upper right corner then click it
2. Fill your basic details in the form then click submit
3. Once you submission is reviewed , an agent will call you to give you more details and enable the account
4. An email will be received to verify the registration email and complete the rest of the details 5-once the account is ready , you can use it to Log-In

Log-In Process

To Log-In please open the following URL:

http://projecthands.azurewebsites.net/login

1. Find User Log-In at the upper right corner
2. Fill your username and password that you registered with
3. Press login

Using User Dashboard

The dashboard i a way to organize all of your tasks, jobs & chats in one place that is customizable by you

1. After you logged-in you can see the Dashboard on the navigation bar
2. Drag the relevant widgets to you dashboard from the widgets inventory
3. For every widgets select which data it will show

Contacting Team Leader

1. Go to the renovation page that the team leader exists in
2. Click on his name on the chat
3. You can contact him by chat or can see his public details and call him

How to Use

Troubleshooting

in any case of problem or bugs , you can contact us by the following ways :

1. Filling the contact us from on the website
2. Open an issue through Issues board

FAQ: General

1. Do i need to install plugins to be able to use the website ?

No , the website is ready to use without any plugins.

2. When i volunteer do they profit money from me ?

No , we do not get paid for the volunteering you do in any of the projects.

FAQ: Operational

1. How to install the server

1. Install dependencies by running npm install
2. Install Karma-cli (Client Testing): npm install -g karma-cli
3. Install Mocha (Server Testing): npm install -g mocha
4. install gulp (Task Runner): npm install -g gulp
5. Install MongoDB & add path-to-folder\MongoDB\Server\<version>\bin to your PATH
6. Seed MongoDB with mock object by running db-seed/db-seed.bat (for Windows, db-seed/db-seed.sh for Linux)

2. How to run tasks and tests

1. karma start - run client unit testing
2. gulp mocha - run server unit testing
3. gulp watch - activate automatic Live Reload & JSHint.
4. gulp css-autoprefixer - automatically add vendor prefixes to CSS rules

3. How to run the server

1. Run MongoDB locally by running mongod in the CLI (optional: --dbpath path to override default path to DB)
2. To run tests: npm test (single run)
3. Run the server: npm start
4. OR Run the server with DEBUG prints: npm run debug
5. Access the server at localhost:8080