We made some changes to server/server.js session part to resolve deployment issue on Heroku (specifically line 136). Thanks for your understanding.

Heroku URL: https://donate-now-team02.herokuapp.com/
 

# install server dependencies in the root directory
cd server 
npm install

# go back to the root directory
cd ..

# install frontend dependencies in the client directory
cd client
npm install

# build the React app
cd client
npm run build

# go back to the root directory
cd ..

# run the server
cd server 
node server.js

Proceed to http://localhost:6001 in the browser and login with the user credentials.
 

docker build -t donate-now .
docker run -d --rm -p 5000:5000 donate-now

mongodb+srv://donatenow:[email protected]/DonateNowAPI

"mongodb+srv://donatenow:[email protected]/DonateNowAPI?retryWrites=true&w=majority"

The only third party library our team used is the Material-UI.
Website URL: https://v4.mui.com/
 

Request URL: http://localhost:6001/login
This is used for verifying a user's credentials (emails and password) when logging into the website. This also add the user ID into the session for the user to remain logged in.
This route is expected to be sent a json file of email and password:

{
    "email": "[email protected]",
    "password": "user" 
}

This route is expected to find the user and start the session if the user is valid, and throw an error message if the user is invalid.

Request URL: http://localhost:6001/logout
This is used for user logging out from the website.
This route is expected to destroy and end the session that the user is currently in, thus log the user out from the website.

Request URL: http://localhost:6001/check-session
This is used for checking if a user is logged in the session and what user type that the user belongs to.
This route is expteced to find the current session and return the information of the user, which includes the User ID and whether the user is admin:

{
    "_id": {
        "$oid": "624514c210743452ec70abf2"
    },
    "admin": false 
}

Request URL: http://localhost:6001/api/createanaccount
This is used for creating a new user account from receiving a user's credentials.
This route is expected to be sent a json file of email and password:

{
    "email": "[email protected]",
    "password": "user" 
}

This route is expected to add the newly created user into the user database for future logins.

Request URL: http://localhost:6001/api/userpage
This is used for getting the current user's information from the session this user is currently in.
This route is expected to return a json file of user's information, which will be displayed on the user's User Information panel under My Profile Page.

Request URL: http://localhost:6001/api/userpage
This is used for updating a user's information when the user edit his profile information on the User Information panel under My Profile page.
This route is expected to be sent a json file of the new version of user's information and to change the User database accordingly.

Request URL: http://localhost:6001/api/userpage
This is used for saving a user's feedback after he submit it through the Submite Feedback page.
This route is expected to be sent a json file containing the feedback information, which will be displayed on the admin's View Feedback page.

{
    "title": "HELP! My request was cancelled for no reason",
    "content": "I noticed my request for a used computer was cancelled suddenly but I was having a successful transaction. I wonder how this occurred?",
}

Request URL: http://localhost:6001/api/userpage/donatedHistory
This is used for getting all the donated history of the current user.
This route is expected to return a json file containing the user/donor's past history of donation, which will be displayed on the user's Donated History panel under My Profile page.

Request URL: http://localhost:6001/api/userpage/transactedHistory
This is used for getting all the transacted history of the current user.
This route is expected to return a json file containing the user/donee's past history of transaction, which will be displayed on the user's Transaction History panel under My Profile page.

Request URL: http://localhost:6001/api/posts
This route is for an user to create and publish a post after filling in all required fields of information on the DONATE NOW page.
This route is expected to be sent a json file containing the new post's information when the user publishes the post, and store it in the Posts database:

{  
   "ownerId":{"$oid":"624732f033cf034ce21c1989"},
   "ownerStatus":"Posted",
   "viewers":[],
   "imageSrc":{"$oid":"624be253e3ad663b8dddbb6e"},
   "deliveryOption":"Pickup",
   "header":"Toys for Kids 5-6 Year Olds",
   "location":"Toronto, ON",
   "description":"I bought the toys 2 years ago for my son, almost as new. He has new toys now and we wish to give away to kids who may like it. Please request only if you can pick it up in Toronto DT, thanks.",
   "categories":["\"Toys, Kids, Parents\""]
}

This route is expected to add the newly created post into the post database.

Request URL: http://localhost:6001/api/post/views/:id
This route helps keep track of number of views of one post from the its Post ID.
This route is expected to find the post from its Post ID in the Post database, and increment the view count by 1. The view count is displayed as an attribute on the Serch Result page and the Post Page.

Request URL: http://localhost:6001/api/post/:id
This route changes the owner status of a post.
This route is expected to find a post from its Post ID in the Post database, and to update the ownerStatus attribute of this post. This change is reflected on the Post Page of this post.

Request URL: http://localhost:6001/api/post/:id/:viewer_id

This route adds the viewer status of a post.
This route is expected to find a post from its Post ID in the Post database, and to add the viewerStatus of the user as an attribute to be displayed on the Post Page of this post.

Request URL: http://localhost:6001/api/post/:id/:viewer_id
This route changes the viewer status of a post.
This route is expected to find a post from its Post ID in the Post database, and to update the viewerStatus attribute of this post. This change is reflected on the Post Page of this post.

Request URL: http://localhost:6001/api/posts/:id
This route browses through all posts and extract all items/posts wishlisted by a certain user from his User ID.
This route is expected to authenticate user, then return a json file of wishlist information.

Request URL: http://localhost:6001/api/post/wishlist/:id
This route counts the number of times a post is wishlisted by users.
This route is expected to browse through all users and count the number of times a Post ID appears in user's wishlists. It then returns this number to be displayed on the post's Post Page as the Saved property.

Request URL: http://localhost:6001/api/post/wishlist/:uid/:pid
This route performs a user's action of adding a post into his Wishlist.
This route is expected to find the target post from the Post ID and the current user from the User ID. It then pushes the post into the user's wishlisted items. This changed is reflected through the Wish List page of the user.

Request URL: http://localhost:6001/api/post/unwishlist/:uid/:pid
This route performs a user's action of removing a post from his Wishlist.
This route is expected to find the target post from the Post ID and the current user from the User ID. It then removes the post from the user's wishlisted items. This changed is reflected through the Wish List page of the user.
 

Request URL: http://localhost:6001/api/filterposts
This routes performs the function of the Search Bar.
This route is expected to get all posts from the Posts database. It displays the posts after filtering the posts with the input keyword and the selected filters from the drop down list on the Search Page.

Request URL: http://localhost:6001/api/post/:id
This route gets a post's information from the Post ID in the Posts database.
This route is expected to return a json file of post information to be processed and displayed on the View Post page:

{
    "ownerId": {
        "$oid": "6247351a33cf034ce21c19a6"
    },
    "ownerStatus": "Posted",
    "viewers": [{
        "viewerId": {
            "$oid": "624732f033cf034ce21c1989"
        },
        "viewerStatus": "Requested"
        }, {
        "viewerId": {
            "$oid": "6247346533cf034ce21c1999"
        },
        "viewerStatus": "Requested"
    }],
    "imageSrc": {
        "$oid": "624be231e3ad663b8dddbb68"
    },
    "deliveryOption": "By Courier",
    "header": "Clothes for Kids 5-6 Year Olds",
    "location": "Toronto, ON",
    "description": "My son grows really fast, these clothes are almost new. We wish to give away to kids who may need it.",
    "categories": ["Clothing", "Toys, Kids, Parents"],
    "views": 34,
    "datePosted": "4/1/2022 08:23",
}

Request URL: http://localhost:6001/images/post
This route addes the new image into the database after it is uploaded by a user while creating a new post.

{
    "image_id": "p839abuv9636hhq3orpg",
    "image_url": "http://res.cloudinary.com/dvskgtzrl/image/upload/v1649140226/p839abuv9636hhq3orpg.png",
}

Request URL: http://localhost:6001/images/user/:uid
This route addes the new image into the database after it is uploaded by a user while uploading his profile picture.

{
    "userId": {
        "$oid": "6247346533cf034ce21c1999"
    },
    "image_id": "ajelgv54jl0nbhbqo0ey",
    "image_url": "http://res.cloudinary.com/dvskgtzrl/image/upload/v1649193457/ajelgv54jl0nbhbqo0ey.jpg",
}

Request URL: http://localhost:6001/images/post/:id
This route finds and returns an image identified by its Image ID from the database.

Request URL: http://localhost:6001/images/:imageId
This route browses through all images and deletes an image identified by its Image ID from the database.

Request URL: http://localhost:6001/api/admin/feedback
This route extracts all the user feedbacks from the Feedback database.
This route is expected to authenticate user and verify the user is admin, then return a json file of feedback information to be displayed on the View Feedback page:

{
    "title": "HELP! My request was cancelled for no reason",
    "content": "I noticed my request for a used computer was cancelled suddenly but I was having a successful transaction. I wonder how this occurred?",
    "isResolved": false,
}

Request URL: http://localhost:6001/api/admin/blocklist
This route extracts all the user information from the User database.
This route is expected to authenticate user and verify the user is admin, then return a json file of user information. The accountBlocked attribute for each user is extracted from each user to be displayed on the Block List page.

Request URL: http://localhost:6001/api/admin/blocklist
This route identifies a user from the User ID, and block or unblock his account.
This route is expected to authenticate user and verify the current user is admin, then extracts a specific user's information from the input User ID and changes this user's accountBlocked status.
 

Request URL: http://localhost:6001/api/termsconditions
This route extracts all the terms and conditions from the database.
This route is expected to return a json file of terms and conditions information to be displayed on the Terms and Conditions page:

{
    "header": "Content",
    "description": "Our Service allows You to post Content. You are responsible for the Content that You post to the Service, including its legality, reliability, and appropriateness."
}

Request URL: http://localhost:6001/api/faqpage
This route extracts all the faqs from the database.
This route is expected to return a json file of FAQ information to be displayed on the FAQ page:

{
    "question": "How can I update my personal information?",
    "answer": "You can access your personal information through clicking into My Profile on the top right corner of the page. You can then update the information by clicking the Edit button at the bottom of the page. Please remember to click Save after you are done.  "
}

1. Log in to the webpage using the following configuration. User will be directed automatically to the Search Result Page for browsing and requesting items.

   Username: [email protected]
   Password: user
   

2. Click on the SEARCH button on the top center to obtain a list of all posts chronologically
   - User can enter keywords in the search bar to search for results that contain the input.
   - To narrow down his/her search range, the user can filter the search results by selecting from the list of dropdowns.

3. Click on a post header or picture in the search/wishlist result to review the post in detail
   - Click on LOGIN TO SEE MORE if the user not logged in.
   - Status will be shown on the top right corner, and changes when viewed by different users.
          - No status will be shown if the item is neither posted or requested by the user.
          - A status of Owner Status: Posted will be shown if the item is posted by the user and the transaction yet to be completed.
          - A status of Owner Status: Completed will be shown if the item is posted by the user and transaction already completed.
          - A status of Viewer Status: Requested will be shown if the item is requested by the user and the transaction yet to be completed.
          - A status of Viewer Status: Completed will be shown if the item is requested by the user and transaction already completed.

4. While viewing a post, user can perform certain actions to change his/her status
   - If item is not wishlisted, click on ADD TO WISHLIST to add this item to the user's wishlist.
   - If the user want to request this item, click on REQUEST NOW to be directed to a dialogue for requesting the item.
   - If the current user is the donor of the item and another user has sent a request, click on CHOOSE DONEE to be directed to a dialogue to choose one donee to receiving this item.
   - If the user has submitted a request and has received a response from the donor, click on COMPLETED or FAILED to be directed to a page for reviewing the transaction result.

5. Click on MY PROFILE on the top right corner to review the user profile
   - If not logged in, a message will prompt user to log in before proceeding.
   - User can access different functionalities by clicking on different tabs in the left panel.
   - In the USER INFORMATION tab, the user can click on Edit button to edit his/her user profile and Save button to update any changes.
   - In the TRANSACTION HISTORY tab, the user can view a list of completed donated that the user received from donnees.
   - In the DONATED HISTORY tab, the user can view a list of his donated items.
   - In the SUBMITE FEEDBACK tab, the user can file a complaint or submit a response to be reviewed by the admin.

6. Click on WISH LIST on the top right corner to review a list of all items the user have wishlisted
   - If not logged in, message will prompt user to log in before proceed.
   - User can click on the header or picture of each post in WISH LIST to review the post in detail.
          - If the user has completed the transaction of the item, a status Viewer Status: Completed will appear at the top of the post.
          - If the transaction is yet to complete, a Request Now button will appear at the top of the post to remind the user. If clicked, a pop up window will appear, asking the user to confirm or cancel his request.

7. Click on DONATE NOW on the top right corner to post a new donation
   - User must fill in all required areas to publish posts.
   - Click on PUBLISH to submit post form, error message will prompt if not all areas are filled.
   - If successfully published, users will be automatically directed to the post page of this new donation. A status bar Owner Status: Posted will appear at the top of the post.

8. Click on FAQ in the bottom footbar to find a list of all frequently asked questions.
   

9. Click on the TERMS AND CONDITIONS to review the terms and conditions for this website.
   

10. Click on the DONATENOW.COM at the top left corner to be redirected back to the home page.
    
     

1. Log in to the webpage using the following configuration:

   Username: [email protected]
   Password: admin
   

2. An ADMIN MODE sign appears on the top right corner to remind the admin of its current mode.
   - Admin navigation menu contains buttons that can direct them to view BLOCK LIST and FEEDBACK.
   - After login, admin is directed to search page by default, they can use the Search Bar just like the regular users.
          - When viewing a post, admin can access the donor/owner's profile by clicking on the User Profile button at the top left of the post.
          - Admin can then review the user's full profile information.

3. Click on VIEW FEEDBACK to find a list of all feedbacks that users have submitted
   - Admin can review the feedbacks submitted by regular users.
   - Click on the User ID in each feedback to have a brief view of User Information.
   - Admin can block this user by clicking on the corresponding button at the bottom of User Information page.

4. Click on BLOCK LIST to find a list of all users
   - Click on each User ID under the Username column to have a brief view of basic user information.
   - Click on the BLOCK/UNBLOCK button under the Action column to block or unblock a specific user.
    
    

The status on each post displays different information depending on the user viewing it and the state of the transaction. This section outlines how the status of a post changes in accordance to the interaction between doner and donee(s).

As the owner of the post, the user might see four types of post status: "Posted", "Donation Matched", "Completed", or "Failed".

This status appears after the user publishes this post of donation on the DONATE NOW page. If this post has been requested by one or more viewers, the user can clicking on CHOOSE YOUR DONEE on the post page to choose one user as the donee from the popup window.

This status appears after the user has chosen one user as the donee from a list of users who requested this post. The user has now become the donor of the chosen donee. The user can now view the chosen donee's personal information by clicking VIEW DONEE INFORMATION button.
After the transaction, the user can also click on COMPLETED or FAILED button to mark this transaction as successful or unsuccessful.

This status appears if the user marks the transaction as completed by clicking the COMPLETED button on top the post page. Synchronously, the donee of the post will now see a status of "Viewer Status: Completed" when viewing this post.

This status appears if the user marks the transaction as failed by clicking the FAILED button on top the post page. Synchronously, the donee of the post will now see a status of "Viewer Status: Failed" when viewing this post.

As the viewer of the post, the user might see four types of post status: "Requested", "Request Accepted", "Completed", or "Failed".

This status appears after the user has requested the item on this post by clicking the REQUEST NOW button. The donor of the post will then have the option to accept or decline this user as the donee.

This status appears if the user's request has been accepted by the donor. The user has now become the chosen donee of the donor. The user can now view the chosen donor's personal information by clicking VIEW DONOR INFORMATION button.
After the transaction, the user can also click on COMPLETED or FAILED button to mark this transaction as successful or unsuccessful.

This status appears if the user marks the transaction as completed by clicking the COMPLETED button on top the post page. Synchronously, the donor of the post will now see a status of "Owner Status: Completed" when viewing this post.

This status appears if one of the following two cases occurs:
       - The user's request has been declined by the donor.
       - This status appears if the user marks the transaction as failed by clicking the FAILED button on top the post page. Synchronously, the donor of the post will now see a status of "Viewer Status: Failed" when viewing this post.