Note: Before logging in, the only options available in the top nav are: "Register", "Log in", "Features" and "Cart". After logging in, users have access to: "Profile", "Support", "Features" and "Cart".

1. Click on “Register” in the top navbar
2. Fill out all the fields in the form
3. Click on the 'Create account' button
4. You will now be taken back to the home page, logged in to your free account

1. Click on the "Log in" button in the top nav
2. Enter your username and password
3. Click the "Log in" button
4. The user will then be redirected back to the homepage, with the message "You have successfully logged in, welcome 'user'"

1. Click on the "Profile" dropdown menu in the top nav
2. Click on the "Log out" option
3. The user will then be redirected back to the homepage, with the message "You have successfully logged out, goodbye 'user'"

1. Click on the "forgot my password" link in the login page
2. This will redirect you to another page, where you must supply your user email
3. An email will then be sent to the supplied email, with details on how to reset your password, and a link to reset your password
4. Clicking on the link redirects the user to another page, where you must supply a new password (must be supplied twice for authentication)
5. If successful the user is redirected to another page where this message is displayed: "Your password has been set. You may go ahead and log in now." and click to log in.

• If the link did not work another message will be displayed instead of the password reset from, i.e: "The password reset link was invalid, possibly because it has already been used. Please request a new password reset.""

1. Click on the "Profile" dropdown menu in the top nav
2. Click on the "'users' features" option
3. This will redirect the user to another page, displaying a list of all the features that the logged in user has purchased (with links to the features full information)

• If the user hesn't yet purchased any features, this message will be displayed: "You haven't bought any features yet".

1. Search options are available in the search bar, just below the "Features welcome message"

2. Users may search using any combination of the three search inputs: search by name, search by feature type and search by feature's current status.

   • Ex: A user could search for a feature where the name contains "sword", the type is "Item" and the status is "Available", then click the "search" button. The search would still function if the user removed any one or two of the inputs.

3. Users can reset the search items by clicking on the "reset" button.

1. Click on a feature's "See more" button
2. Scroll down to the "thumbs up" icon
3. Click on the icon to like the feature
4. The like counter will then increment by one, showing the like

• If the user has already liked the feature, the like will not be counted and the page will refreash and a message will appear ("You have already liked this")

1. Click on a feature's "See more" button
2. Scroll down to the "add to cart" button (this will only be accessible if the features current status is "Available")
3. Click to add the item to your cart, the 'Cart' icon in the top nav will then increment by one (or will show a "1" if it was previously empty)
4. Click on the "Cart" icon to be taken into the user's cart
5. The user's cart items will then be displayed, along with the total amount due and a checkout button (this option will only be accessible if the cart is not empty)
6. Click on the "checkout" button
7. This will redirect users to the checkout page, containing two forms: one for the users information and the other for payment information.
8. Fill in all the fields in each form (a prompt will arise if left empty)
9. Click on the "Submit Payment" button.
10. If the payment is sucessful, the user is redirected to another page, displaying a success message and a link to go back to the "features" page.

Note: Please be aware that the stripe payment processing is only currently set up to process payments using the test card. Therefore, error messages will not be displayed for incorrect information in the "payment form". If incorrect information is input and the "Submit payment" button is clicked, nothing will appear to happen.

1. Click on the "Support" dropdown in the top nav.
2. Click on the "Performance" option.
3. The user will then be redirected to the "Performance" page, where all the charts are displayed.
4. There are 4 charts for features: Top 5 features by user likes, Current feature types, Amount of bugs per features and the popularity of each types of feature.

• You can see more information about the chart by hovering over the "?" icon by the chart title
• In addition to the numerical values displayed in the charts, hovering over each bar/point/segment will show additional information.

1. Search options are available in the search bar, just below the "Bugs welcome message"

2. Users may search using any combination of the three search inputs: search by name, search by bug type and search by bug's current status.

   • Ex: A user could search for a bug where the name contains "Base game", the type is "Base game" and the status is "Fixed", then click the "search" button. The search would still function if the user removed any one or two of the inputs.

3. Users can reset the search items by clicking on the "reset" button.

1. Click on a bug's "See more" button
2. Scroll down to the "bug" icon
3. Click on the icon to upvote the bug
4. The upvote counter will then increment by one, showing the upvote

• If the user has already upvoted the bug, the upvote will not be counted and the page will refreash and a message will appear ("You have already upvoted this").

1. Click on a bug's "See more" button
2. Scroll down to the comments section
3. Click on the "Add comment"
4. A modal window will appear with an area to input the comment and a "Save" button
5. Add your comment and click the "Save" button
6. The modal window will disappear and the comment will be displayed at the top of the comments section (including the user's name and date posted)

1. Click on the "Add bug" button
2. A modal window will appear with a form for inputting the bugs information
3. Once the "Add bug" button is clicked, the modal window disappears and the users bug is displayed at the top of the bugs section.

Note: The status of new bugs is always "To do" and is to be changed by the admin the user panel.

1. Click on the "Support" dropdown in the top nav.
2. Click on the "Performance" option.
3. The user will then be redirected to the "Performance" page, where all the charts are displayed.
4. There are 3 charts for features: Top 5 bugs by user upvotes, new bugs uploaded in the past week and current bug statuses (no. of bugs To do, Doing and fixed)

• You can see more information about the chart by hovering over the "?" icon by the chart title
• In addition to the numerical values displayed in the charts, hovering over each bar/point/segment will show additional information.

• Each app has it's own 'tests.py' containing the tests for that particular app. As mentioned in 'Components left to implement', these automated tests only check whether the correct page is rendered correctly.

• To run the tests, type into the console:

python3 manage.py run test

• All the tests will then run and provide feedback in the console.
• To test that the tests can fail, there is a test designed to fail here. Uncomment out the 'FAIL test' and then re-run tests to see the test failing.

• Manual tests were conducted on all the components (descirbed in components) and on the JQuery code for the site. All manual tests for the comppnents follow the instructions given in components, and thus these test descriptions will only provide the results of each test.

Tests for major components:

1. Account

• Form for registering a new user will only submit if all fields are full, and contains the correct information (i.e: password 1 and 2 must match and be longer than 6 characters). The provided username and email must also be unique.
• When user tries to log in with correct information, they are logged into the corret account. If fields are empty or incorrect (not in the databse) the user is not logged in.
• The "forgot my password" button correctly redirects users to a page where they must supply their email. The email then sends to the correct email address (using the created email template). The link supplied in the email then works to redirect users to a new page where they can input a new password. This newly created password can then be used to log in correctly.
• When a user clicks on "username's features" they are shown a list of the features that they have bought, or an error message if they haven't yet bought any features.

2. Features:

• When users hover over the "thumbs up" icon on the feature's information page (featuresInfo.html) the icon becomes green. Clicking on the icon will then increment the like counter by 1. Users who have clicked are saved in a list, so that if they click it again, an error message appears.
• Once the user has items in their cart the "checkout" button on checkout.html becomes available and users can go to the checkout page. Leaving any form input empty will prompt a "Field required" message. Using the correct information (user and credit card) will redirect the user to a "payment complete" page and a message will be displayed at the top (with a correct payment message).

Note: The stripe payment processing is set to test currently, therefore only the test card information will allow a purchase. In addition, the error messages will not display whilst in test mode, therefore no error messages are displayed if incorrect data is put into the form, the form just won't be submitted until correct info is used. To learn more see the stripe documents.

3. Support:

• Hovering over the 'bug' symbol changes the colour to green, and clicking on this symbol will then increment the upvote number by one. If a user who has already upvoted that bug tries to upvote again, it will not work and an error message is displayed.
• Clicking the 'add a comment' button displays the correct modal window, and the submit button then saves the comment. The comment is then correctly displayed (with the correct username and time of posting). Adding new comments pushes the older ones down the page.
• CLicking the "add a bug" button correctly displays the modal window, with all required inputs. Once submitted, the new bug correctly displays on the bugs page, with new bugs offsetting older bugs down the page. The correct information for the bug is also displayed (i.e: the status, date of creation, type of bug and number of upvotes).

Note: As the performance and search apps are separate from bugs and features, their tests are described below.

4. Other:

• Users are able to search for any bug/feature using the search bar, using any combination of the 3 search inputs. The correct results are displayed, from the correct database (i.e: if searching from bugs page, only bugs are displayed). The correct search information messages are also displayed when a search is made.

• The performance page results were then checked manually to ensure that the data displayed reflects the actual databse values. The hover messages and numerical values were also checked, and are displaying correctly.

• dj-database-url and psycopg2 was installed to facilitate communication bewteen our django app and the Heroku database

• The code was updated in "settings.py" as to change between the deployed and local databases (depending on whether the environmental varibales come from a local env.py file or the deployed environment)

• The database was then migrated over to the deployed database.

• Created an S3 bucket (for complete instructions, click here)

  • set to "static website hosting"
  • Added a bucket policy and CORS configuration
  • Then created a user (with a "AmazonS3FullAccess" policy attatched)
  • Downloaded the 'credentials.csv' file and input the keys into the code.

• Integrated S3 and Django (for complete instructions, click here)

  • updated "settings.py" by adding "storages" to INSTALLED_APPS.
  • And added variables required (descirbed in instructions)

• Also hosted our "media" files (images uploaded for use in 'features'):

  • A 'custom_storages.py' file was created (code here)
  • Following variables were added to 'settings.py': STATICFILES_STORAGE = "custom_storages.StaticStorage" and STATICFILES_LOCATION = 'static'

• Linked up the Github repository to the Heroku (follow these instructions)

• Created a requirements.txt file:

sudo pip3 freeze --local > requirements.txt 

• Installed gunicorn (to allow us to connect to Heroku)

• Created a Procfile:

echo web: gunicorn nordlander.wsgi:application > Procfile

• Following varibales set in Heroku: AWS_SECRET_ACCESS_KEY, AWS_SECRET_ACCESS_KEY, EMAIL_ADDRESS, EMAIL_PASSWORD, SECRET_KEY, STRIPE_PUBLISHABLE, STRIPE_SECRET and DISABLE_COLLECTSTATIC = 1 (this stops Heroku from trying to re-upload the static files)

• 'import env' in 'settings.py' was then commented out

• The code was then added, commited and pushed to Github

Note: There will be an error until you add the site to ALLOWED_HOSTS in 'settings.py'.