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
124 changes: 40 additions & 84 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,54 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===
## Class Data Manager
This website allows users to input class names and IDs, and extracts from the IDs the
class level. It then adds to or edits a list of classes, IDs, and levels, and reports
to the same page of the website a list of the classes and their information. This
list is reprinted every time a new change is made to the data.

Due: September 8th, by 11:59 AM.
In order to use the application, one must input the class name and number into their
respective fields and press the sunmit button. If the class number is unique, a new
class will be added to the list. If the class number is the same as one already in the
list of classes, the older class name will be replaced with this new name.

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.
I used flexbox for the title ("Class Data Manager" in blue) and the description of the
website in orange, lining them up next to each other.

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 (complete at least two) 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
---
## Technical Achievements
- **Tech Achievement 1**: I have made this application single-page. There are two
fields in which the user can enter class names and class numbers, and every time the
submit button is pressed, the updated list of classes and numbers is re-printed on the
same webpage. The user can still press the button and continue to reprint the list on
the page after it is initially printed.

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.
### Design/Evaluation Achievements
- **Design Achievement 1**: I tested my UI with two individuals; My tasks and notes
for each of them are listed below.

*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.
User 1 Task: First, add the class “Webware” with ID 4241. Then, update the class name
to “Webware: Computational Technology”

*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:
User 1 Last Name: Smith

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!
User 1 problems the user had: She wished that the text in the input fields would disappear
when she went to input information.

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:
User 1 comments that were surprising: The text was a little too small and the orange was a
little hard to read.

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?
User 1 changes I would make based on feedback: I would make the text in the input fields be
something that disappeared when the user went to click on it. I would also change the
font, color, and size of the text on the website to be easier to read.

*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.
User 2 Specific task:
First, add the class “Bean Time” with ID 2326. Then, update the class name to “BEAN TIME”

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

## 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.
User 2 problems the user had: She neglected to read the instructions for updating and
got confused on how to do so until she saw the instructions. She also didn’t like that
the text in the input fields didn’t disappear when they

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
User 2 comments that were surprising: It was very simple but she didn’t notice that there
were instructions at the top of the page. She thinks the font was too small.

### Design/Evaluation Achievements
- **Design Achievement 1**:
User 2 changes I would make based on feedback: Make the directions more obvious and add the
word “DIRECTIONS:” to them. I would also increase the font size somewhat.
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "",
"version": "",
"description": "",
"author": "",
"name": "Class Data Manager",
"version": "1.0.0",
"description": "Simple website to record and maintain a list of classes",
"author": "Sidney Goldinger",
"scripts": {
"start": "node server.improved.js"
},
"dependencies": {
"mime": "^2.4.4"
"mime": "^2.6.0"
}
}
46 changes: 45 additions & 1 deletion public/css/style.css
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
/*Style your own assignment! This is fun! */
/*Style your own assignment! This is fun! */
@import url('https://fonts.googleapis.com/css?family=Sofia')

body {
background-color: coral;
color: blue;
font-family: "Sofia";
}

h1{
display: flex;
flex-direction: row;
align-items: center;
color: darkblue;
size: 2em;
}

p {
color: darkblue;
}

button {
color: darkblue;
font-family: "Sofia";
background: lightblue;
}

#para1 {
color: orange;
}

p.center {
color: teal;
}

.box {
display: flex;
margin-left: auto;
margin-right: auto;
border-width: 100px;
flex-direction: row;
align-items: center;
padding: 10px;
margin-right: 10px;
}
90 changes: 83 additions & 7 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,112 @@
<head>
<title>CS4241 Assignment 2</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<form action="">
<input type='text' id='yourname' value="your name here">
<div class="box">
<h1>Class Data Manager</h1>
<p id="para1">
Welcome to the Class Data Manager, where you can maintain
and update a list of your classes.
</p>
</div>
<p class="center">
DIRECTIONS: Input your class name and number and press submit to see results. If you enter
a new class name with the same class number, we will update that class's name
in the server.
</p>
<form action="" method="post">
<input type="text" id="classname" value="class name here" font-family="Sofia">
<input type="text" id="classnumber" value="class number here" font-family="Sofia">
<button>submit</button>
</form>

</body>
<script>

const loadData = function( e ) {
e.preventDefault()

fetch( '/submit', { // url to send it to
method:'GET',
body
})
.then( response => {
return response.json()
})
.then( json => {
json.forEach( item => {
// debugger

const p = document.createElement('p')
p.innerText = "Class Level: " + json.classlevel
p.innerText += ", Class Name: " + json.classname
p.innerText += ", Class Number: " + json.classnumber
document.body.appendChild( p )

})
}) //what he has
.then( function( response ) {
// do something with the reponse // started with these lines
// alert("Here")
//console.log( response )
})
}

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

const input = document.querySelector( '#yourname' ),
json = { yourname: input.value },
const inputClassname = document.querySelector( '#classname' )
const inputClassnumber = document.querySelector ('#classnumber'),

json = { "classname": inputClassname.value,
"classnumber": inputClassnumber.value},

body = JSON.stringify( json )

fetch( '/submit', {
fetch( '/submit', { // url to send it to
method:'POST',
body
})
.then( response => {
//debugger //DEBUGGER
return response.json()
}) //what he has
.then( json => {
//json.forEach( item => {
// debugger
//document.body.appendChild("Updated Data:")

const po = document.createElement('p')
//p.innerText = "Updated Data: `\n`"
po.innerText += "Updated Data: "
document.body.appendChild( po )

json.forEach( item => {
const p = document.createElement('p')
//p.innerText = "Updated Data: `\n`"
p.innerText += "Class Level: " + item.classlevel
p.innerText += ", Class Name: " + item.classname
p.innerText += ", Class Number: " + item.classnumber
document.body.appendChild( p )
})
//})
}) //what he has
.then( function( response ) {
// do something with the reponse
console.log( response )
// do something with the reponse // started with these lines
// alert("Here")
//console.log( response )

})

return false
}

window.onload = function() {

const button = document.querySelector( 'button' )
button.onclick = submit
}
Expand Down
4 changes: 3 additions & 1 deletion public/js/scripts.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// Add some Javascript code here, to run on the front end.

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

// my frontend js code is in the index.html file
41 changes: 35 additions & 6 deletions server.improved.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ const http = require( 'http' ),
port = 3000

const appdata = [
{ 'model': 'toyota', 'year': 1999, 'mpg': 23 },
{ 'model': 'honda', 'year': 2004, 'mpg': 30 },
{ 'model': 'ford', 'year': 1987, 'mpg': 14}
{ 'classname': 'Calculus 1', 'classnumber': 1999, 'classlevel': 1 },
{ 'classname': 'Databases 1', 'classnumber': 2004, 'classlevel': 2 },
{ 'classname': 'Intro to Art History', 'classnumber': 1987, 'classlevel': 1}
]

const server = http.createServer( function( request,response ) {
Expand All @@ -34,16 +34,45 @@ const handlePost = function( request, response ) {
let dataString = ''

request.on( 'data', function( data ) {
dataString += data
dataString += data
})

request.on( 'end', function() {
console.log( JSON.parse( dataString ) )
//console.log( JSON.parse( dataString ) )
dataString = JSON.parse( dataString )

// ... do something with the data here!!!
const classname = dataString.classname
const classnumber = dataString.classnumber
const classlevel = parseInt(dataString.classnumber/1000)

// if classnumber already exists, change name
let doesExist = false
for (const elt of appdata) {
if (elt.classnumber == classnumber) {
elt.classname = classname
doesExist = true
}
}
// else, appdata.push
if (!doesExist) {
appdata.push({ 'classname': classname, 'classnumber': classnumber, 'classlevel': classlevel})
}
//appdata.push({ 'classname': classname, 'classnumber': classnumber, 'classlevel': classlevel})

// testing
//console.log(appdata)

//console.log(classlevel + " " + classnumber + " " + classname)

response.writeHead( 200, "OK", {'Content-Type': 'text/plain' })
response.end()

response.end( JSON.stringify(appdata))
/*
response.end( JSON.stringify({ classlevel: classlevel,
classname: classname,
classnumber: classnumber })) // sends back this?
*/
})
}

Expand Down