forked from cs4241-19a/a2-shortstack
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Glitch (a2-brian-earl)
committed
Sep 8, 2019
1 parent
ec47c9c
commit da51773
Showing
5 changed files
with
99 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,89 +1,24 @@ | ||
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js | ||
=== | ||
|
||
Due: September 9th, by 11:59 AM. | ||
## Pirate Crew Generator | ||
This project is a Pirate Crew generator used for generating and keeping track of members in a pirate crew | ||
- You generate a crew by selcting the crew member you wish to add's rank from a drop down menu and entering their name and year of birth into repective feilds and pressing the submit button. | ||
- The current crew will is shown in a table on screen. | ||
- Any crew member can be modified by entering thier name into the name feild, entering thier new rank and/or year of birth and then pressing the modify button. | ||
- Any crew member can also be removed from the crew by entering their name into the name feild and pressing the delete button. | ||
- "Reset" and "Clear" buttons are also present under the crew table which, when pressed, will reset the crew back to the default list and clear the entire crew respectively | ||
|
||
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. | ||
Another aim of this assignment is to establish creative boundaries in which you and your partner can explore designing, implementing, and evaluating usable, useful, novel, and technically efficient web applications. | ||
|
||
Baseline Requirements | ||
--- | ||
|
||
Note that there is a very large range of application areas and possibilities that meet these baseline requirements. | ||
Games, internet of things, organizational tools, commerce, media - all are possibilities with a two-tiered form-focused web application. | ||
|
||
Do not limit yourselves to any of the examples given below. | ||
Examples like the upcoming `efficiency_ratio` idea for the `cars` dataset are meant to be illustrative and easy to understand. | ||
They are not intended to be sensible or useful ideas. | ||
|
||
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 `cars` dataset with `year`, `horsepower`, and `fuel_efficiency` may create a new field `efficiency_ratio` by dividing `fuel_efficiency` by `horsepower` | ||
|
||
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 | ||
- Clarification: the results page can be implemented in any way. `<div>`s, `table`s, and `list`s are common choices | ||
|
||
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 sizing of the primary visual elements in the application: | ||
- CSS to cause at least one element to be horizontally centered on the page | ||
- CSS to cause at least one pair of elements to appear side-by-side | ||
- 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: | ||
|
||
1. Fork the starting project code. 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. Only one member needs to submit a pull request. | ||
|
||
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. | ||
Images are encouraged, along with concise, high-level text. | ||
|
||
Here is a sample formula for summarizing your activities, talk about: | ||
- the domain area the project pertains to | ||
- the main challenges or problems the application addresses | ||
- the key innovations that make it possible to address the problem | ||
- the main results of the implementation, does it really address the problem? | ||
- any additional implications of the resulting application, or possibly areas for future work that have been discovered as part of the design and implementation activities | ||
|
||
(Note that when I use the above formula, I aim to have only one sentence per thought in order to remain concise.) | ||
|
||
http://a2-charlieroberts.glitch.me | ||
https://a2-brian-earl.glitch.me/ | ||
|
||
## Technical Achievements | ||
- **Tech Achievement 1**: Using a combination of... | ||
- **Tech Achievement 2**: ... | ||
- **Tech Achievement 1**: Rewrote the server using Express to handle the Post and Get requests | ||
- **Tech Achievement 2**: Implemented Jquery in the client to handle Get requests and manipulate HTML elements | ||
- **Tech Achievement 3**: Used SQLite as a database to store the users data on the server | ||
- **Tech Achievement 4**: Generate a unique id for each entry based on the crew member's name | ||
|
||
### Design/Evaluation Achievements | ||
- **Design Achievement 1**: Shown in `style.css`, the code... | ||
- **Design Achievement 2**: We tested the application with n=X users, finding that... | ||
- **Design Achievement 1**: Changed the color scheme to a sepia tone color pallete well as making changes to the HTML elements such as adding borders in the table and changing the spacing between elements to make the whole website more readable, as seen in style.css | ||
- **Design Achievement 2**: Used the website https://www.bestcssbuttongenerator.com/ to generate css code for the buttons | ||
- **Design Achievement 3**: Used the website enjoycss.com to generate css code for the inputs | ||
- **Design Achievement 4**: Disallowed invalid actions such as trying to delete or modifying a crew memvers who are not in the table or adding a crew member that is already in the table by using alerts telling the user that their input is invalid | ||
- **Design Achievement 5**: Sort the table by the crew member's rank in the same way it is arranged in the drop down menu |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters