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
11 changes: 11 additions & 0 deletions .project
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>a2-shortstack</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>
99 changes: 14 additions & 85 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,22 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===

Due: September 16th, by 11:59 PM.
http://a2-lindbergsimpson.glitch.me/

This assignment aims to introduce you to the concepts and practice involved in creating a prototype (i.e. not deployment ready) two-tiered web application. The baseline aims of this assignment involve creating an application that demonstrates the use of several specific pieces of HTML, CSS, JavaScript, and Node.js functionality.

Baseline Requirements
---

Note that there is a very large range of application areas and possibilities that meet these baseline requirements. 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>` 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/)

- 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. 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 2020 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-yourname` so we can find it.
6. Modify the README to the specifications below.
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.
## Lindberg's Package Delivery Service
This project is a page that would allow clients to send packages through a courier. To use this project, input the description of the package, the weight of the package in pounds and the deadline (in number of days) for the package to reach the destination. The application then calculates and displays the cost of this shipment based on the weight of the package and the deadline. I used CSS grid for the positioning technique to allow the form to be on one side of the page, and the table/database to be on the other side.

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
- **Tech Achievement 1**: This single-page app utilizes a combination of forms and tables so that a user can submit data, and the app will display both the data and the result of the derived field. The three fields used here are the description, weight and deadline, while the derived field is the cost of shipment.

### Design/Evaluation Achievements
- **Design Achievement 1**:
- **Student Interview 1**: <br />
Student Last Name: Owuor <br />
Problems: The number inputs allow me to enter negative numbers.<br />
Surprising Comments: I could see this being a real application or business if you developed it further.<br />
Changes to be made based on feedback: Implement a checker that displays a popup/error message when a user attempts to enter negative numbers in the number fields.<br /> <br />
- **Student Interview 2**: <br />
Student Last Name: Patel <br />
Problems: When nothing is input in the description field, the app still creates a new row without a package description. Also, the page itself is very empty. <br />
Surprising Comments: The color scheme does not look very good. <br />
Changes to be made based on feedback: Cater to this edge case by implementing a check to ensure all fields are filled before the submit funciton processes the data. Also, a popup could be displayed telling the user to ensure the fields are filled before clicking the submit button and a couple pictures could be added to make the page more appealing.
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "",
"version": "",
"description": "",
"author": "",
"name": "a2-shortstack",
"version": "1.0",
"description": "CS-4241 Assignment 2: Basic Two-tier Web Application using HTML/CSS/JS and Node.js",
"author": "Lindberg Simpson",
"scripts": {
"start": "node server.improved.js"
},
Expand Down
60 changes: 59 additions & 1 deletion public/css/style.css
Original file line number Diff line number Diff line change
@@ -1 +1,59 @@
/*Style your own assignment! This is fun! */
/*Style your own assignment! This is fun! */

h1 {
font-family: 'Yanone Kaffeesatz', sans-serif;
font-weight: bold condensed;
font-size: 50px;
padding:10px;
background-color: #ff512c;
text-align: center;
}

th {
font-family: 'Kufam', cursive;
font-weight: bold;
font-size: 20px;
color: #030507;
padding:10px;
background-color: #29897c;
border: 3px solid black;
}

td {
font-family: 'Kite One', sans-serif;
font-size: 18px;
color: #000000;
border: 1px solid black;
}

body {
background-color: #29897c;
}


table{
border: 3px solid black;
}

.input_section {
font-family: 'Kufam';
font-size: 15px;
}

.grid-container {
display: grid;
grid-template-columns: auto auto auto;
grid-column-gap: 50px;
grid-row-gap: 50px;
justify-content: space-between;
align-content: space-evenly;
}

.item1{
grid-area: 1 / 1 / span 1 / span 1;
}

.item2 {
grid-area: 1 / 2 / span 1 / span 1;
}

62 changes: 31 additions & 31 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,39 @@
<head>
<title>CS4241 Assignment 2</title>
<meta charset="utf-8">
<link href="https://fonts.googleapis.com/css2?family=Kite+One&family=Kufam&family=Yanone+Kaffeesatz&display=swap" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="css/style.css">
<script src="js/scripts.js"></script>
</head>
<body>
<form action="">
<input type='text' id='yourname' value="your name here">
<button>submit</button>
</form>
</body>
<script>

const submit = function( e ) {
// prevent default form action from being carried out
e.preventDefault()

const input = document.querySelector( '#yourname' ),
json = { yourname: input.value },
body = JSON.stringify( json )
<h1> Lindberg's Package Delivery Service </h1>
<div class="grid-container">
<div class="input_section item1">
<form id="package_form">
<label for="description">Item Description:</label>
<input type='text' id='description' placeholder="E.g: Book"><br>
<label for="weight">Weight (in lbs):</label>
<input type='number' id='weight' placeholder="2"><br>
<label for="deliv_date">Delivery Date (number of days from today):</label>
<input type='number' id='deliv_date' placeholder='3'><br>
<button>submit</button> <br> <br>
</form>

</div>
<div class="results_section item2">
<table id="package_table">
<tr>
<th>Description</th>
<th>Weight (lbs)</th>
<th>Day(s) until delivery</th>
<th>Cost of shipment (USD)</th>
</tr>
</table>
</div>
</div>


fetch( '/submit', {
method:'POST',
body
})
.then( function( response ) {
// do something with the reponse
console.log( response )
})

return false
}

window.onload = function() {
const button = document.querySelector( 'button' )
button.onclick = submit
}

</script>
</body>

</html>
54 changes: 54 additions & 0 deletions public/js/scripts.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,57 @@
// Add some Javascript code here, to run on the front end.

const submit = function( e ) {
// prevent default form action from being carried out
e.preventDefault()

/*
const description = document.querySelector( '#description' ),
weight = document.querySelector( '#weight' ),
deliv_date = document.querySelector( '#deliv_date' ),
*/

const newpackage = {
description: document.querySelector( '#description' ).value,
weight: Math.abs(document.querySelector( '#weight' ).value),
deliv_date: Math.abs(document.querySelector( '#deliv_date' ).value),
price: Math.abs(document.querySelector( '#weight' ).value) + 20*(1/(1 + Math.abs(document.querySelector( '#deliv_date' ).value)))
}

/*
json = { yourname: input.value },
body = JSON.stringify( json )
*/
const body = JSON.stringify( newpackage )
console.log(body);
var table = document.getElementById('package_table');
var new_row = table.insertRow(1);
var new_desc = new_row.insertCell(0);
var new_weight = new_row.insertCell(1);
var new_days = new_row.insertCell(2);
var new_cost = new_row.insertCell(3);

new_desc.innerHTML = newpackage.description;
new_weight.innerHTML = newpackage.weight;
new_days.innerHTML = newpackage.deliv_date;
new_cost.innerHTML = "$" + newpackage.price.toFixed(2);


fetch( '/submit', {
method:'POST',
body
})
.then( function( response ) {
// do something with the reponse
console.log( response )
})

return false

}

window.onload = function() {
const button = document.querySelector( 'button' )
button.onclick = submit
}

console.log("Welcome to assignment 2!")