ToolShare


CONTACT: jvd5839@rit.edu


ToolShare Instructions:

Installation (For Internet Explorer users):

1.) Ensure that Javascript is enabled in Internet Explorer. If you are unsure how to enable Javascript in IE, consult Microsoft support.
2.) Proceed with the normal installation instructions.

Installation:

1.) In the windows file explorer, navigate to the folder you downloaded the ToolShare application to.
2.) double click on the run.py file in the ToolShare folder.
3.) When you are asked to make a super user account, select "no".
4.) Minimize the command prompt window that pops up. Keep this up for the duration of using the program.
5.) Open your browser of choice and type 127.0.0.1:8000 in the URL. The home page for ToolShare should pop up.


*************************
old version:
1.) In the windows file system, navigate to the folder location where manage.py resides in the outer ToolShare folder.
2.) If a file named db.sqlite3 resides in this folder, delete it.
3.) Hold shift, right click in any blank space in the window of this folder and select “Open command window here”
4.) Type “python manage.py syncdb” in the command prompt and press enter.
5.) Type “python manage.py runserver --insecure” in the command prompt and press enter.
6.) Open your browser of choice and type 127.0.0.1:8000 in the URL. The home page for ToolShare should pop up.
***************************



Using ToolShare:


Registering and Logging in:

1.) Click "Register" on the main page.
2.) Fill in the fields and press "Submit". If any input is erroneous for this form or any other form on the site (ex. letters when there should be numbers, trying to register a username that's already taken), the form will either notify you or reset with blank fields.
3.) Log in with the username and password you just created.
4.) The site will initially prompt you to join a community or make a new community. Follow the steps below.


Joining a community:

1.) If you aren't on the community selection page and are logged in, click "Community" in the top nav bar. Otherwise, go to step 3.
2.) Click "Change Community" from the drop-down menu.
3.) You should now be at the community selection page. Click "Join" under the desired community to join.


Creating a new community:

1.) If you aren't on the community selection page and are logged in, click "Community" in the top nav bar. Otherwise, go to step 3.
2.) Click "Change Community" from the drop-down menu.
3.) You should now be at the community selection page. Click "Create a new community" at the bottom of the list.
4.) Give the community a name and a zipcode.
5.) Click "Create Community"


Sharing From Home or From A Shed:

1.) See "Adding a Tool to Your List of Tools", step 4.


Adding a Tool to Your List of Tools:

1.) Click “Home” on the top nav bar.
2.) Click “Tools” on the top nav bar.
3.) Click “Add tool” from the drop-down menu.
4.) Fill out all the necessary information.*

        *Sharing from home or from a shed:
        1.) There’s a “shed” in the dropdown menu from the list of sheds, titled “Home”, which can be selected if sharing from home is desired.
        2.) Selecting any other option requires approval from a shed admin.

5.) Click “Create Tool”
6.) You will be brought back to the home page, and the tool will be added.


Searching for Tools:

1.) Click “Home” on the top nav bar.
2.) Use the search bar in the top nav bar to search for tools.


Requesting to Borrow a Tool:

1.) Click “Home” on the top nav bar.
2.) Click “Tools” on top nav bar.
3.) Click "Browse Tools" from the drop-down menu.
4.) Browse through the list of tools and select the tool you wish to borrow.
5.) Click “Reserve”
6.) Fill out the form that appears.
7.) A confirmation page should be displayed.


Setting a blackout date:

1.) Click “Home” on the top nav bar.
2.) Click “Tools” on top nav bar.
3.) Click “My Tools” from the drop-down menu.
4.) Click the tool you wish to set a blackout date on.
5.) Click “Set Blackout Date”.
6.) Edit the form as desired.
7.) Click “Reserve Tool”. Reserving your own tool for a desired period has the same effect as setting a blackout date.


Accepting/Denying Tool Borrow Requests:

1.) Click “Home” on the top nav bar.
2.) Click “Mail” on the top nav bar.
3.) Click “Borrow Requests” from the drop-down menu.
4.) If someone has requested to borrow your tool, the request will be displayed here. Accept or deny the requests by clicking the appropriate button below the request.
5.) If "Deny" was clicked, provide a reason why.
6.) An appropriate confirmation page will be displayed.


Viewing Tools You Have Borrowed:

1.) Click “Home” on the top nav bar.
2.) Click “Tools” on the top nav bar.
3.) Click “Borrowed Tools” from the drop-down menu.


Returning a Tool:

1.) Click “Home” on the top nav bar.
2.) Click “Tools” on the top nav bar.
3.) Click “Borrowed Tools” from the drop-down menu.
4.) Click “Return this tool” under the tool you want to return.
5.) A confirmation will be displayed on the current page.


Editing a Tool:

1.) Click “Home” on the top nav bar.
2.) Click “Tools” on top nav bar.
3.) Click “My Tools” from the drop-down menu.
4.) Click the tool you wish to edit.
5.) Click “edit”.
6.) Edit the form as desired.
7.) Click “Update Tool”.


Activating/deactivating a Tool:

1.) Click “Home” on the top nav bar.
2.) Click “Tools” on top nav bar.
3.) Click “My Tools” from the drop-down menu.
4.) Click "Deactivate" under the tool you wish to restrict others from borrowing. Note that this can only be performed if no one else is borrowing a tool.
5.) This feature can also be used from the tool's page.


Editing The User:

1.) Click “Home” on the top nav bar.
2.) Click “Edit my info”.
3.) Edit the form as desired.
4.) Type in your password, and confirmation.
5.) Press “Update”.


Sending a Private Message:

1.) Click “Home” on the top nav bar.
2.) Click “Mail” on the top nav bar.
3.) Click “Create New Message” from the drop-down menu.
4.) Fill out the fields and select a recipient, other than yourself, through the Receiver drop-down menu.
5.) Select “Send Message.”


Viewing Messages received:

1.) Click “Home” on the top nav bar.
2.) Click “Mail” on the top nav bar.
3.) Click "Inbox" from the drop-down menu.
4.) View a list of messages you have received.


Viewing Sent Messages:

1.) Click “Home” on the top nav bar.
2.) Click “Mail” on the top nav bar.
3.) Click “Sent Messages” from the drop-down menu.
4.) View a list of messages you have sent.


Posting to The Community Board:

1.) Click “Home” on the top nav bar.
2.) Click “Add a post!” on the main page.
3.) Fill out the fields, and press “Submit Post”.
4.) On completion, the post should be shown on the main page.


Creating a Shed:

1.) Click “Home” on the top nav bar.
2.) Click “Community” on the top nav bar.
3.) Click “Create Shed” from the drop-down menu.
4.) Fill out the fields.
5.) On completion, the shed will be added.


Managing Sheds:

1.) Click “Home” on the top nav bar.
2.) Click “Manage” on the top nav bar.
3.) Click “Manage Sheds” from the drop-down menu.
4.) Click a shed to view shed information.


Managing the Community:

1.) Click “Home” on the top nav bar.
2.) Click “Manage” on the top nav bar.
3.) Click “Manage Community” from the drop-down menu.
4.) Edit any necessary information.


Viewing Users in Your Community:

1.) Click “Home” on the top nav bar.
2.) Click “Community” on the top nav bar.
3.) Click “Users in my Community” from the drop-down menu.
4.) A list of users will be displayed.


Changing Communities:

1.) Click “Home” on the top nav bar.
2.) Click “Community” on the top nav bar.
3.) Click “Change Community” from the drop-down menu.


Viewing Community Statistics:

1.) Click “Home” on the top nav bar.
2.) Click “Community” on the top nav bar.
3.) Click “Community Statistics” from the drop-down menu.


Closing ToolShare:

1.) Close the command prompt that opened when first running ToolShare.
2.) Close all browser windows/tabs associated with ToolShare.


**************************************************************************

Known Bugs and Disclaimers:

1.) For nearly every form on the site, all fields are deleted if any invalid data is in the fields upon submission. Other forms on the site don’t have this behavior.

2.) Inconsistent warning messages: For removing a message, the warning message is an alert popup, but for banning users, the warning message is a popup built into the page.

3.) Joining a community when logging in the first time brings you to the URL 127.0.0.1:8000/toolshare/select, but changing communities at any other time (after logging in, for instance) brings you to the URL 127.0.0.1:8000/toolshare/change_community with an identical page. A user can still get to 127.0.0.1:8000/toolshare/select by typing it into the URL bar after logging in the first time.

4.) "Edit my info" (next to "Log Out") navigates to a broken page.

5.) Some forms don't notify you of the exact problem with the fields if they're filled in incorrectly, or if they're left blank.

6.) Usernames are case sensitive on login.

7.) A tool can be edited, including moving it from home to shed or vice versa, after someone requests to borrow it.

8.) Reservation/blackout dates can be set before the current date.

9.) When a blackout date is being set, you will be redirected to the page that is used for setting up a reservation. Fill out the fields for the times when you don't anyone else to be using the tool. Unfortunately, the blackout dates cannot be edited once you accept them.

10.) For convenience, the list of users appears at the bottom of the page when searching for tools. That way, a user can be found by searching for a tool that the user has.

11.) Clicking “Home” on the top nav bar is not always a required step. The top nav bar should always be there, and all options from the nav bar should be accessible from every page, but if not, going to the home screen guarantees this behavior.