Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

a2-chrisvieira-christopher-vieira #84

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 33 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,56 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===
# WPI Computer Science SA, TA, and GLA Tracking Sheet
This project allow the user the ability to enter information for WPI Computer Science Department Senior Assistants, Teaching Assistants, and Graduate Learning Assistants. This all contained in a single web page which automatically updates after every action.

Due: September 9th, by 11:59 AM.
In order to position my elements, I used the CSS grid format. This allowed me to have whitespace on either side of my main content section while also organizing my Input Area and Tutorial Area.

This assignment aims to introduce you to creating a prototype two-tiered web application.
Your application will include the use of HTML, CSS, JavaScript, and Node.js functionality, with active communication between the client and the server over the life of a user session.
In order to use my application, please read the Tutorial Area (labeled "How To Use"). This is also shown below.

Baseline Requirements
---
All testing was completed in Chrome and Firefox.

There is a large range of application areas and possibilities that meet these baseline requirements.
Try to make your application do something useful! A todo list, storing / retrieving high scores for a very simple game... have a little fun with it.
How To Use:
- Enter the necessary information in the Input Area.
- When you've entered new information, click Add Entry.
- To remove a item, click the Remove Entry button in the respective row.
- To update a item, input the necessary information you wish the result to contain in the Input Area and add click the respective row's update entry.

Your application is required to implement the following functionalities:

- a `Server` which not only serves files, but also maintains a tabular dataset with 3 or more fields related to your application
- a `Results` functionality which shows the entire dataset residing in the server's memory
- a `Form/Entry` functionality which allows a user to add, modify, or delete data items residing in the server's memory
- a `Server Logic` which, upon receiving new or modified "incoming" data, includes and uses a function that adds at least one additional derived field to this incoming data before integrating it with the existing dataset
- the `Derived field` for a new row of data must be computed based on fields already existing in the row.
For example, a `todo` dataset with `task`, `priority`, and `creation_date` may generate a new field `deadline` by looking at `creation_date` and `priority`

Your application is required to demonstrate the use of the following concepts:

HTML:
- One or more [HTML Forms](https://developer.mozilla.org/en-US/docs/Learn/HTML/Forms), with any combination of form tags appropriate for the user input portion of the application
- A results page displaying all data currently available on the server. You will most likely use a `<table>` tag for this, but `<ul>` or `<ol>` could also work and might be simpler to work with.
- All pages should [validate](https://validator.w3.org)

CSS:
- CSS styling of the primary visual elements in the application
- Various CSS Selector functionality must be demonstrated:
- Element selectors
- ID selectors
- Class selectors
- CSS positioning and styling of the primary visual elements in the application:
- Use of either a CSS grid or flexbox for layout
- Rules defining fonts for all text used; no default fonts! Be sure to use a web safe font or a font from a web service like [Google Fonts](http://fonts.google.com/)
## Technical Achievements
- **Tech Achievement 1** (10 points): Using a combination of GET and POST requests, I created a single-page app that both provides a form for users to submit data and always shows the current state of the server-side data. Every button the user can click leads to a POST request being send to the server. This POST request will return the list of all data entries currently in the server's memory. This also persists through the frontend restarting whether through a page refresh, opening a new page, etc. Every time the page is reset, a GET request gets the updated list of information from the server. This ensures that the client is never out of data and the table won't act buggy when adding that first entry after a refresh.
- **Tech Achievement 2** (5 points): Update and remove table entry functionality are working as intended.

- CSS defined in a maintainable, readable form, in external stylesheets
### Design/Evaluation Achievements
- **Design Achievement 1** (5 points): User study 1 was completed and is listed below.

JavaScript:
- At minimum, a small amount of front-end JavaScript to get / fetch data from the server; a sample is provided in this repository.
1. Provide the last name of each student you conduct the evaluation with.

Node.js:
- An HTTP Server that delivers all necessary files and data for the application, and also creates the required `Derived Fields` in your data.
A starting point is provided in this repository.
Stephano Jordhani

Deliverables
---
2. What problems did the user have with your design?

Do the following to complete this assignment and acheive a base grade of 85%:
We discovered an issue where my update and delete actions did not work in Firefox, they only functioned in Chrome. He did not dislike anything involving the layout itself.

1. Fork the starting project code (make sure to fork the 2021 repo!). This repo contains some starter code that may be used or discarded as needed.
2. Implement your project with the above requirements.
3. Test your project to make sure that when someone goes to your main page, it displays correctly.
4. Deploy your project to Glitch, and fill in the appropriate fields in your package.json file.
5. Ensure that your project has the proper naming scheme `a2-yourGithubUsername` so we can find it.
6. Modify the README to the specifications below, and delete all of the instructions originally found in this README.
7. Create and submit a Pull Request to the original repo. Label the pull request as follows: a2-gitusername-firstname-lastname
3. What comments did they make that surprised you?

Acheivements
---
I was surprised 2/3 of the actions did not work in Firefox, I didn't expect there to be such a difference between browsers. There were no surprising comments about comments on the layout itself.

Below are suggested technical and design achievements. You can use these to help boost your grade up to an A and customize the assignment to your personal interests. These are recommended acheivements, but feel free to create/implement your own... just make sure you thoroughly describe what you did in your README and why it was challenging. ALL ACHIEVEMENTS MUST BE DESCRIBED IN YOUR README IN ORDER TO GET CREDIT FOR THEM.
4. What would you change about the interface based on their feedback?

*Technical*
- (10 points) Create a single-page app that both provides a form for users to submit data and always shows the current state of the server-side data. To put it another way, when the user submits data, the server should respond sending back the updated data (including the derived field calculated on the server) and the client should then update its data display.
I would not make any changes to the interface itself based on this feedback, I did change the front-end to be Firefox compatible, however.

- **Design Achievement 1** (5 points): User study 2 was completed and is listed below.

*Design/UX*
- (5 points per person, with a max of 10 points) Test your user interface with other students in the class. Define a specific task for them to complete (ideally something short that takes <10 minutes), and then use the [think-aloud protocol](https://en.wikipedia.org/wiki/Think_aloud_protocol) to obtain feedback on your design (talk-aloud is also find). Important considerations when designing your study:
1. Provide the last name of each student you conduct the evaluation with.

1. Make sure you start the study by clearly stating the task that you expect your user to accomplish.
2. You shouldn't provide any verbal instructions on how to use your interface / accomplish the task you give them. Make sure that your interface is clear enough that users can figure it out without any instruction, or provide text instructions from within the interface itself.
3. If users get stuck to the point where they give up, you can then provde instruction so that the study can continue, but make sure to discuss this in your README. You won't lose any points for this... all feedback is good feedback!
Yihong Xu

You'll need to use sometype of collaborative software that will enable you both to see the test subject's screen and listen to their voice as they describe their thoughts. After completing each study, briefly (one to two sentences for each question) address the following in your README:
2. What problems did the user have with your design?

1. Provide the last name of each student you conduct the evaluation with.
2. What problems did the user have with your design?
3. What comments did they make that surprised you?
4. What would you change about the interface based on their feedback?
The issue he encountered was having difficulty with the update field, it isn't as straight forward as it should be as you enter the new entries and update entries in the same area.

*You do not need to actually make changes based on their feedback*. This acheivement is designed to help gain experience testing user interfaces. If you run two user studies, you should answer two sets of questions.
3. What comments did they make that surprised you?

Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
---
I was not surprised by any comments, they all were fairly expected.

## Your Web Application Title
Include a very brief summary of your project here. Be sure to include the CSS positioning technique you used, and any required instructions to use your application.
4. What would you change about the interface based on their feedback?

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
I would probably spend some extra time to change how update works, whether it uses separate input fields or whether it is a two step process as it is a little confusing.

### Design/Evaluation Achievements
- **Design Achievement 1**:
15 changes: 15 additions & 0 deletions node_modules/.bin/mime

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions node_modules/.bin/mime.cmd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions node_modules/.bin/mime.ps1

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading