Skip to content

a2-tcaplan-Thea-Caplan #67

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.

Sign up for GitHub

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

Open
tcaplan wants to merge 15 commits into
base: main
Choose a base branch
from
Open

a2-tcaplan-Thea-Caplan #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
fbbea7e
got base features added
tcaplan Sep 11, 2023
8cda84f
gitignore
tcaplan Sep 11, 2023
cd53654
fixing favicon
tcaplan Sep 11, 2023
dad7612
fix
tcaplan Sep 11, 2023
6ce9ba8
fix
tcaplan Sep 11, 2023
8f79701
Merge branch 'cs-4241-2023-main'
tcaplan Sep 11, 2023
71ed49f
finished baseline requirements and technical achievements
tcaplan Sep 11, 2023
4d67fee
added link
tcaplan Sep 11, 2023
b20a81e
fixing formatting
tcaplan Sep 11, 2023
c10a785
reformatted to have forms on top
tcaplan Sep 11, 2023
0e58925
final html changes
tcaplan Sep 12, 2023
ea7a5a0
readme update and bug fix
tcaplan Sep 12, 2023
c3b1e4e
tiny typo spotted
tcaplan Sep 12, 2023
4c4c435
readme change
tcaplan Sep 12, 2023
3f1c1c6
readme change
tcaplan Sep 12, 2023
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
135 changes: 57 additions & 78 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,100 +1,79 @@
Thea Caplan
Link: https://a2-tcaplan.glitch.me

Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===

Due: September 11th, 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.
## College Schedule Maker
This application is a class schedule maker that allows users to input their classes and view a table representation of the class schedule by day. Users can add, remove, and modify classes as desired. It is a single-page application that shows the current status of the server (stored data) at all times. CSS grid positioning was used to format the application.

Baseline Requirements
---
The application includes 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.

My tabular dataset:
An object array of class information, where each class has:
1. Name (required)
2. Class Code (optional)
3. Start Time (required)
4. End Time (required)
5. Days the class meets (at least 1 required)
6. Length of the class (derived)

## Technical Achievements
**Created a Single-Page App**: The application is a one page application where the dataset stored in the server is updated in real time whenever a change is made to the dataset (submitting, removing, or modifying data)

**Modification Of Data Enabled**: Along with adding and removing data from the server, users are allowed to modify existing data through the modification form.

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.
## Design/Evaluation Achievements
**Think-Aloud Protocol**: Ran 2 think-alouds to test the design of the website.

Your application is required to implement the following functionalities:
Prompt: Add 2 of your classes to the schedule, then modify 1 class to have class on a Sunday.

- 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 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`
Student 1:
1. Last Name: Logan
2. Problems: Didn't see the classes in the schedule before adding, so having 2 classes with the same name was confusing.
3. Surprising Comments: Liked the words at the box line for labeling
4. Changes based on feedback: Expected the classes to be organized positionally by time rather than just sorted. (Would have implemented with more time :( )

Student 2:
1. Last Name: Chang
2. Problems: The dropdowns needed a second click to update the data shown. (Bug fixed in final submission)
3. Surprising Comments: Liked the labels, described the form layouts as intuitive
4. Changes based on feedback: Fix the dropdown second click bug. (Bug was only noticed when using arrow keys, fixed in final submission)

## Baseline Requirements
---
- a `Server` (ADDED)
- a `Results` functionality (ADDED)
- a `Form/Entry` functionality (ADDED)
- a `Server Logic` (ADDED)
- the `Derived field` (ADDED)

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)
- One or more [HTML Forms](https://developer.mozilla.org/en-US/docs/Learn/HTML/Forms) (ADDED (3 forms for adding, removal, and modifying) (text, time, select, and checkbox inputs))
- A results page displaying all data currently available on the server. (ADDED (single page app - data showed in table))
- All pages should [validate](https://validator.w3.org) (PAGE VALIDATES)
- If your app contains multple pages, they should all be accessible from the homepage (index.html) (NOT INCLUDED - using a single page application - no navigation neccessary)

CSS:
- CSS styling of the primary visual elements in the application
The forms are boxed in and organized to be readable.
The data table that shows all the information in the dataset is colored with alternating row colors for readability.
- Various CSS Selector functionality must be demonstrated:
- Element selectors
- ID selectors
- Class selectors
- Element selectors (body, header, main, td, fieldset label, section, article, h3, h2)
- ID selectors (singleClassDisplay, leftContent, rightContent)
- Class selectors (grid-item, grid-container, left, right, column)
- 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/)
- Use of either a CSS grid or flexbox for layout (ADDED - using grid)
- Rules defining fonts for all text used; no default fonts! (ADDED - using courier)

- CSS defined in a maintainable, readable form, in external stylesheets
- CSS defined in a maintainable, readable form, in external stylesheets (1 CSS file)

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

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 2023 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. Remember, the highest grade you can get on any individual assignment is a 100%.

*Technical*
- (5 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.

- (5 points) In addition to a form enabling adding and deleting data on the server, also add the ability to modify existing data.

*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 fine). 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, or conduct the studies in person. 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.

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...

### Design/Evaluation Achievements
- **Design Achievement 1**:
- An HTTP Server that delivers all necessary files and data for the application, and also creates the required `Derived Fields` in your data. (ADDED)
23 changes: 23 additions & 0 deletions package-lock.json
View file
Open in desktop

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

8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "",
"name": "a2_assignment",
"version": "",
"description": "",
"author": "",
"description": "College Schedule Maker",
"author": "Thea Caplan",
"scripts": {
"start": "node server.improved.js"
},
"dependencies": {
"mime": "^2.4.4"
"mime": "^2.6.0"
}
}
124 changes: 123 additions & 1 deletion public/css/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,126 @@
@import url("https://fonts.googleapis.com/css2?family=Courier+Prime&display=swap");
body {
background:black;
margin: 0;
font-family: "Courier Prime", monospace;
background:rgb(40, 40, 40);
color:white;
}

header {
text-align: center;
}

main {
display: grid;
}

main .column {
margin-left: 50px;
margin-right: 50px;
max-width: fit-content;
text-align: center;
}

form {
border: 1px white solid;
max-width: fit-content;
text-align: center;
padding: 10px;
padding-bottom: 20px;
text-align: center;
display: inline-block;
}

.grid-container {
display: grid;
max-width: fit-content;
text-align: center;
}

.grid-item {
padding: 10px;
}

.grid-item label :not(fieldset) {
padding-right: 5px;
}

.grid-row {
display: grid;
text-align: center;
}

.grid-item .right {
float: right;
padding-left: 10px;
}

.grid-item .left {
float: left;
padding-left: 10px;
}

#leftContent {
grid-column: 1 / 2;
}

#middleContent {
grid-column: 2 / 3;
}

#rightContent {
grid-column: 3 / 3;
}

.classForm {
margin-bottom: 50px;
}

td {
padding: 30px;
}

tr:nth-child(odd) {
background-color: #40567a;
}
tr:nth-child(even) {
background-color: #4C8BF5;
}

fieldset label {
padding-left: 15px;
}

.warning {
color: red;
}

.classDisplay h2 {
font-size: larger;
}

.classDisplay h3 {
font-size: large;
}

.classHeader {
padding: 10px
}

#singleClassDisplay {
border: 1px solid white;
padding: 10px;
padding-left: 30px;
padding-right: 30px;
}

/* Schedule Display */

#dataView {
margin: 0 auto;
margin-bottom: 50px;
}

#dataView th {
padding: 5px 5px 10px 10px;
}
Loading