allyharrison / agile-web-dev-cits5505 Goto Github PK

Agile Web Dev group project for Stevie, Neha, Kartik and Ally.

HTML 55.94% JavaScript 2.01% CSS 3.58% Python 38.21% Mako 0.26%

agile-web-dev-cits5505's Introduction

Foodie Hub - CITS5505 Agile Web Development project

Name	Student Number	GitHub Username
Alexandra Harrison	22581066	allyharrison
Kartik Bhalala	23244793	kartikbhalala
Neha Neha	23754739	neha2007796
Stevie Dahlin	22974467	St-d603

About The Project

Our website is all about food! FOODIE HUB is designed to be a one stop shop for all foodies.

Looking for something to eat? Look no further, Foodie Hub is a community where users can share their favourite recipes or even ask the community for recommendations. How about finding a new favourite place to eat? On Foodie Hub you can ask for suggestions, or visit our blog to find some Hidden Gems.

Looking for a recipe similar to one your Grandma made years ago but don't know where to start? Ask our Foodie Hub community to help you discover and make delicious flavours and meals!

Foodie Hub offers the chance to interact with like minded and taste-budded people alike. Check us out!

How to run the project

To run the project locally, follow the instructions below to set up a venv, then pip install requirements-dev and then run flask.

# Activate virtual environment
python3 -m venv tmp-env
source tmp-env/bin/activate

# Install these dependencies for development
pip install -r requirements-dev.txt # (this will also install requirements.txt)

# OR install only these dependencies for production
pip install -r requirements.txt

# Apply migrations
flask db upgrade 8f09b1c4c9ea

# Launch container for search functionality
docker run --name elasticsearch -d --rm -p 9200:9200 --memory="2GB" -e discovery.type=single-node -e xpack.security.enabled=false -t docker.elastic.co/elasticsearch/elasticsearch:8.11.1

# Start app
flask run

If you would like to run with "livereload" for editing HTML/CSS, run python local_dev.py instead of calling flask run. Note: This doesn't apply to changes to Python files.

python local_dev.py

Tests

This directory contains the test files for the project.

Test Files

test_app.py: This file contains the unit tests for the application.
test_selenium.py: This file contains the Selenium tests for the application.

Running the Tests

Before running the tests, ensure you have the server running in the background, as well as the elasticsearch Docker container (see root README for instructions)

Unit Tests

To run the unit tests, use the following command:

python3 -m unittest test_app.py

Selenium Tests

To run the selenium tests, use the following command:

python3 ./test_selenium.py

agile-web-dev-cits5505's People

Contributors

Watchers

Forkers

st-d603 kartikbhalala

agile-web-dev-cits5505's Issues

Creating Tests

Current test ideas as the HTML and CSS validations. Still in planning.

Plan out front-end page structure using Figma

This will be screen-captured and sent to the group chat for group approval.

The main feature it should capture is:

Request Creation: Users can create food-related requests, such as recipe challenges, restaurant recommendations, and cooking quests.
Request Answering: Other users can respond to these requests by submitting their solutions, recipes, or culinary creations.

(Complete in 3 days- latest Tuesday, week 6)

Create new GitHub project

Create new project to use for our Agile Web Dev group assignment.

Explore testing options

Look into how we should approach testing, and consider what should be tested (and when)

Javascript research

Research and outline the necessary JavaScript functions for the design, including implementing a user account and tracking feature.

Update README file

Basic CSS

Small task, content to be updated throughout the project life cycle
CSS to follow up
With HTML and Figma layout, start basic CSS creation and alignment.
potential library research

New database research

It seems that SQLite is the required database for this project. Has anyone used it before?

Basic CSS

Small task, content to be updated throughout the project life cycle
CSS to follow up
With HTML and Figma layout, start basic CSS creation and alignment.
potential library research

Refine HTML, CSS and general frontend in preparation for first deliverable

Tidying up the frontend so we can use landing page and request pages as the first deliverable.
Looking to:

improve responsiveness for mobiles and small screens
improve existing responsiveness of text and images (i.e. resizing window currently causes most text fields to shift differently, menu dropdown becomes warped on hover)
refine theme to make it more cohesive

fix alignment of signup and login buttons on the home page

Ability to search user interaction

Fixing signup and login placeholder

HTML population and css related to it

Add to HTML and front page

Fill out parts of existing HTML that aren't complete

Add footer
Add buttons to navbar, and list options as list underneath:
- Recipes (ie breakfast, lunch, dinner)
- Cuisine (ie Indian, Chinese, Italian)
- Making a request - this can be part of the menu and/or a persistent button on the other pages

Website logo has some credit lines

Add the rough draft images

Could you please add a file containing the rough blog design images that you made at the start of the project! I noticed that we forgot to upload that :)

Ability to user interaction and response

test

html

I think we should have 3 or 4 sections for the webpage design such as Recipes based on (Breakfast, Lunch and Dinner), Recipes for cuisines and a blog style section?

Research sign in options

Research ways to add user authentication functionality, could be normal user login and/or SSO with Google/Facebook etc.

Some possibilities:

for normal login, we could do something like this - https://www.freecodecamp.org/news/how-to-authenticate-users-in-flask/
for SSO, we could do something like this - https://dev.to/simplelogin/create-a-flask-application-with-sso-login-f9m

User story game feature

Based of the our brainstormed user stories: maybe we should look to incorporate a FOODIE Website gamification feature? For example, if you post a certain amount or respond to recipe requests you can receive badges. It could work to foster community engagement on the foodie website.

My issue is:

What would be the point of the badge (purely just aesthetics, maybe profile pictures)?

Risk: user could make many posts and receive badge even though its not interactive or helpful.

Should it actual be more game based like a chef puzzle (it could reveal a recipe at random when solved)

If we choose this option would it be unlimited? Daily

Or does anyone else have any ideas?

Collect content to fill out pages on website

What information will be in these pages?

Collect recipes to have in pages (maybe 5?)
Additional website details and content can be included.
Small task, content to be updated throughout the project life cycle

HTML to align with Figma design

While the design is in the creation in Figma, a rough HTML bone structure should be made.
Update once we agree on design.
Completed by the end of week six - will continue to be updated throughout the project duration.

Database research

Investigate methods for storing interactions and results, potentially exploring database options such as SQLite or PostgreSQL. Determine which databases will be suitable for our project's needs.

Test merge branch on local

Review Flask App

If the upcoming flask is merged could someone look at sub-dividing the app.py per lecture tutorial (19th), if possible or ask a tutorial, I think it may look more efficient/ in-line with practices if it is divided up? I'm not 100% sure on this so let me know if you have any thoughts.