Skip to content
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
131 changes: 37 additions & 94 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,41 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===

Due: September 8th, by 11:59 AM.

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.

Baseline Requirements
---

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.

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. Alternatively, you can create a single-page app (see Technical Acheivements) but this is not a requirement.
- All pages should [validate](https://validator.w3.org)
- If your app contains multple pages, they should all be accessible from the homepage (index.html)

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/)

- CSS defined in a maintainable, readable form, in external stylesheets

JavaScript:
- At minimum, a small amount of front-end JavaScript to get / fetch data from the server; a sample is provided in this repository.

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.

Deliverables
---

Do the following to complete this assignment and acheive a base grade of 85%:

1. Fork the starting project code (make sure to fork the 2022 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

Acheivements
---

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.

*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.

*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. 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!

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:

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?

*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.

Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
---

## 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.
Reagan Brunelle
https://a2-rmbrunelle.glitch.me/

## Music Playlist Creator
Summary: Music Playlist Creator. My project is a pretend music playlist. The user can add songs with specific name, artist, duration, and album, and see the playlist length in minutes on the right after each song. This way the user can know at what point in the playlist a song will play.

Special Instructions: You must enter a number in the "Duration of song" field for it to work properly. It will round down to nearest integer.
- If an error is made when typing in a response, the playlist length field will not work unless you relaunch by removing the server.improved file and pasting it in again in glitch
- note that I tried to get a reset button working but couldn't get it compatible with my laylist length derived field. To check how it works with the reset button activated, uncomment const reset in scripts.js and uncomment the "if undefined" and its closed brace a few lines below in addToPlaylist

some CSS Details to note:
- Used an html form for gathering song info and a table to display the results instantly - italized form values, highlighted labels
- Derrived field - the playlist length is tallied after each song is added. This way the user can see at which point in the playlsit that a certain song will play.
- Flexbox - in the header with 2 band pictures and my title
- CSS class for values in playlist length column - blue and underlined
- CSS id for form values and first row of results - bold and colored
- Google font - Merriweather
- Various other colors are used with css element selectors
- Styling and scripting are done in external sheets
- No default fonts are used
- submit and reset buttons are used

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
- **Tech Achievement 1**: My results table automatically updates from the server when a new song is submitted. I need this my editing the appending the innerHTML of the results table directly with the data collected by the server. This is called whenever the submit button is pressed, which provides instantanious results from the server to the client.

Why this was challenging: it was difficult to append data to the results table and keep the header at the same time. This is because the method I used appends data and overrides what is in the table, thus forgetting about the header. I fixed this by recreating the header outside of the for each loop every time a new song is added.

### Design/Evaluation Achievements
- **Design Achievement 1**:
- **Design Achievement 1**: Shane Stevens think-aloud (we reviewed each others)
- Last name: Stevens
- Task: Make a 5 songs playlist
- Problems: He pointed out that it would be easier to enter data if I automatically clear input fields when clicking on a form box. He also sugguested that I use a reset button for the playlist.
- I was suprised that he liked my fonts and pictures. I felt they could've been risky choices.
- I would specify that song duration needs to be in minutes and ideally I should handle seconds as well. I also did implement the clear input fields feature and a reset button.

- **Design Achievement 2**: Y. Zhu think-aloud (we reviewed each others)
= Last name: Zhu
- Task: make a 5 song playlist of a total of 22 minutes long
- Problems: When he first looked at my page, I did not have much styling, so I made it look much better.
- He thought it was easy to understand how to use
- I could've used an actual color scheme as opposed to random colors I chose
12 changes: 12 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.

28 changes: 28 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.

18 changes: 18 additions & 0 deletions node_modules/.package-lock.json

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

Loading