k-straiton / cits3403-project Goto Github PK

HTML 40.43% CSS 11.19% Shell 0.09% Python 45.40% JavaScript 2.89%

cits3403-project's Introduction

CITS3403-Project

Purpose of the Application

ThinkMad is a discussion forum site that allows ThinkPad users and enthusiasts to share their knowledge, help others, and talk about all things ThinkPad related. It uses a question and response system, with users being able to create an account, and then use this account to post questions and respond to existing questions from other users.

Group Members

Student ID	Name	Github Username
22957747	Kirsty Straiton	K-Straiton
23343513	Lauren Pudney	laurenpudz
23417131	Sebastian Gazey	Sebagabones
23599356	Sersang Ngedup	sersangn

Architecture

How to Launch

For the following steps make sure you are in the root directory of the repository.

Create a python virtual environment

python3 -m venv .venv

Activate the environment

source .venv/bin/activate

Install the requirements

pip install -r requirements.txt

Create the secret key enviroment variable

export FLASK_SECRET_KEY='<SECRET_KEY_OF_YOUR_CHOICE>'

Create the database

flask db init

flask db migrate

flask db upgrade

Run the app

flask run

Add dummy data to the server
- Once the flask app is running, open a new terminal in the same directory.
- Activate the python virtual enviroment in the new terminal
- Then run the following command

flask add_data

How to Run Tests

Unit tests

Activate the virtual environment and export secret key (as shown in the steps above)
Run

python3 -m unittest tests/unittests.py

Selenium

Have Chrome installed and ready to launch
Activate the virtual environment and export secret key (as shown in the steps above)
Run

python3 -m unittest tests/selenium.py

cits3403-project's People

Contributors

Stargazers

Watchers

cits3403-project's Issues

Minor search fixes

Minor fixes to improve search function and usability:
Change page name for search results page to ThinkMad Search - [query]
Add notice for end of search results so that users know when no search results remain, and it is more obvious when a query has not returned any results.

Create template for navbar

Create basic template for navbar that can be added to pages. Navbar should be responsive and contain ThinkMad logo.

Add logout and login session functionality

Add backend features for logging out and terminating the login session.

Remove duplications on stylesheet

Many styles in the stylesheet appear to have been duplicated, some multiple times. Duplicate styles should be removed so that each only appears once.

Create log in page

Create a basic login page. This will be front end only for now.

Change single choice buttons on pronouns to multi-select

Could we change the pronouns select on sign-up to instead of being only able to select one option, to being able to select multiple? Not sure if we could then change it so that if someone selects multiple options the pronouns tab on the profile page (and pronouns in general) just uses one from each option? We could maybe switch from buttons to drop down letting you choose the order/number you want? Not urgent and would love to hear y'alls thoughts on it

Make page to view posts

Make a page to view posts from the home page with comments and the post.

Set up directory structure

In root there should be index.html and all other html pages. There should be a resources folder with css, js, and images subfolders.

Remove the flask secret key from the repo and make an it an environment variable

Currently our secret key is in the init file. It should be made an environment variable and grabbed using a config script. Also update the README with instruction regarding this.

Make homepage automatically redirect to login

Have the homepage automatically redirect to the login page for the the first deliverable. This will change later.

Add video for deliverable 2

Upload the video for the second deliverable

Add outline to README according to specs

Add the headings to the README file

Purpose of the Application
Group Members
Architecture
How to Launch
How to Test

Attempt to get reply to comments functionality

Try get replying to comments functionality

Change colour of commenter's username on comments page

Commenter's usernames on comment page are currently white - page would look more appealing and it would be easier to tell comments apart if the commenter's names where different colours.

Fix flash function usage

Fix the flash function use

Make number of responses/comments and show comments done by a user in profile

Update profile page to show the comments and number of them by a user on a profile

Add UserMixin to user db

Add UserMixin to the user database like mentioned in security lecture

Fix .gitignore not ignoring pycache correctly

Currently /pycache and /app/pycache is still being tracked. These have been added to the .gitignore file earlier but these folders and files need to be removed from the repo for the .gitignore stuff to work.

Add pagination

Add ability to change number of ThinkPads on profile page

Allow users to change number of ThinkPads owned on their profile.

Remove the database file and add to .gitignore

Make response box on post page stick to the bottom of the viewport

Currently the field to add a comment to a post is located under the post and above all the responses. This field needs to be styled, and made sticky to the bottom of the viewport so you can type and send a reply no matter how far you have scrolled through the comments.

Reformat the nav bar

Reformatting the navigation bar so that it's layout is more user friendly and modern. Also, make the fonts the same, and remove the old logout button, and potentially make the search icon larger

Create incorrect username or password alert (and succesfully signed up alert)

We need to add a way to alert a user that a username or password entered is incorrect - bootstrap alerts look promising

Add basic custom css to style.css

Add some basic css to the style.css file. This should be enough to get basic and consistent styling across the pages. The colour theme will be based on Tokyo Night theme.

Add database features for posts

Adding features for adding a new post, editing and deleting

Live update comments (and possibly posts) without needing to refresh page

Use Ajax

Log in on main not working

On logging into the site, the redirection to /profile throws an error of form being undefined, but that seems to be due to some code being present in profile.html that shouldn't be there (must have been missed in a PR review).
Removing

 <form name="editCount", action="", method="post">
          {{form.hidden_tag()}}
          {{form.ThinkPadCount(placeholder="Username", size=8, class="form-control my-2", id="usernameInput", type="number")}}
          {{form.editCount(type="submit")}}

   </form>

from profile.html should fix it

Add password check on sign-up page

Add a client side check on the sign-up page to check if both Password and Confirm Password fields have the same value before sending data to server.

Create a sign up page

Create a sign up page. This will be front end only for now.

Create a user profile page

Create a user profile page that can be viewed when logged in. It will show a user's username, pronouns, the number of questions asked, the number of responses, the number of thinkpads owned, and a section where you can swap between viewing the user's questions and responses.

Add video and tag for first deliverable

Create a deliverables folder and put the first video in it. Create a tag to match the first deliverable.

Setup Database

Setting up basic database structure

Setup flask forms

Add flask forms backend

Add flask-wtf to requirements.txt

Need to add add flask-wtf to requirements.txt

Create modal for creating a new post

Create a pop up modal that will contain a form for the user to fill out when creating a new post. It will have fields for the title and the body. It will have a 'Cancel' and 'Post' button, and no cross/exit button.

Create test cases as per lecture requirements

Heya people - we need to make a bunch of test cases like we were told in the lecture - I know we have been testing as we go using our personal preferred methods, but we need to make sure we have scalable testing :)

Add redirect to log in button on sign in page

Can we pretty pretty please make the login button on the sign in button redirect to the log in page? Lots of ways to do it - could do a form or just a on click href
https://stackoverflow.com/questions/3303675/how-to-make-an-input-type-button-act-like-a-hyperlink-and-redirect-using-a-get-r

Add project description to README

Add the description for our project under the Purpose of the Application heading in the README.md file.

Change the styling of the link to view posts and users

Need to change the way we access the posts, and users, as currently it's just a text link, which isn't ideal

Add css and logo to login and sign up pages

Update login and sign up pages with custom css classes and logo

Add tags/badges

Add the ability to put tags on posts. There should be a set list of tags to choose from when creating a post. Having the tags be clickable as well to filter the posts would also be really good.

Adding Selenium WebDriver tests

Create home page

Create a basic home page font end.

Change the styling of the comments and replies

Change the styling of the comments and replies to match the figma

Chrome form highlighting issue

On Chromium based browsers, when filling in the form on the login page and sign-up page, either with autofill passwords, or with simple html form autofill, the background in the username and password boxes both change to a white colour instead of staying the colour they are normally.

          Not sure if we will do this before the assignment is due - we should remove the current placeholder examples though

Originally posted by @Sebagabones in #73 (comment)

As per above