Difference between revisions of "Mean Stack"
Line 11: | Line 11: | ||
== Individual Assignments == | == Individual Assignments == | ||
− | === Install Node.JS === | + | === Install Node.JS and Socket.IO === |
Install Node.JS from Apt or Yum according to the instructions in the [[Node.JS]] guide. | Install Node.JS from Apt or Yum according to the instructions in the [[Node.JS]] guide. | ||
− | === Static File Server === | + | Also install Socket.IO globally (using the ''-g'' option). |
+ | |||
+ | === Static File Server in Node.JS === | ||
The individual portion of Module 7 is short in order to give you enough time to complete the group portion. | The individual portion of Module 7 is short in order to give you enough time to complete the group portion. | ||
Line 29: | Line 31: | ||
#* ''phpinfo.php'', a PHP file containing the phpinfo command that generates a diagnostic page of the server: | #* ''phpinfo.php'', a PHP file containing the phpinfo command that generates a diagnostic page of the server: | ||
#: <source lang="php"><?php phpinfo(); ?></source> | #: <source lang="php"><?php phpinfo(); ?></source> | ||
− | # Boot up your Node.JS static fileserver and load all four of the files you created in step 4. | + | # Boot up your Node.JS static fileserver, and from your browser, load all four of the files you created in step 4. |
#: Which ones work and which ones don't? Why might this be the case? | #: Which ones work and which ones don't? Why might this be the case? | ||
== Group Project == | == Group Project == | ||
+ | |||
+ | In the group portion of Module 7, you will be building a multiplayer Pong game using Node.JS and Socket.IO. | ||
+ | |||
+ | If you want to reminisce and play some Pong on the command line before building it in Node.JS, here is the command, assuming you have '''emacs''' installed: | ||
+ | |||
+ | <source lang="bash">$ emacs -q --no-splash -f pong</source> | ||
+ | |||
+ | Press '''C-x C-c''' to exit emacs. | ||
=== Socket.IO Pong Game === | === Socket.IO Pong Game === | ||
+ | |||
+ | First thing first: set up a static file server running Node.JS. We will need it in order to serve up our HTML and JavaScript content. | ||
+ | |||
+ | To start, download this file and save it in your ''static'' directory: http://classes.engineering.wustl.edu/cse330/content/pong-game.js | ||
+ | |||
+ | ==== About the Pong-Game.JS File ==== | ||
+ | |||
+ | We created the ''pong-game.js'' file for you to save you time and so that you can focus on the Node.JS and Socket.IO aspects of this module. This file contains the core Pong engine, but it does ''not'' establish communication between users of any kind. | ||
+ | |||
+ | If you are curious, we used the [http://www.limejs.com/ LimeJS] framework as the backbone of ''pong-game.js''. You can find the pre-compiled source code for the Pong game here: | ||
+ | |||
+ | * http://classes.engineering.wustl.edu/cse330/content/pong.js | ||
+ | * http://classes.engineering.wustl.edu/cse330/content/ball.js | ||
+ | |||
+ | We then used the [https://developers.google.com/closure/compiler/ Google Closure Compiler] to compile all of the libraries you need into the one modular JavaScript file. | ||
+ | |||
+ | Just to be clear, ''for the purposes of Module 7, you do not need to bother with either LimeJS or Google Closure.'' | ||
+ | |||
+ | '' todo: finish '' | ||
== Grading == | == Grading == | ||
Line 40: | Line 69: | ||
We will be grading the following aspects of your work. There are 100 points total. | We will be grading the following aspects of your work. There are 100 points total. | ||
− | # '''Individual Portion ( | + | # '''Individual Portion (20 Points):''' |
− | #* Node.JS | + | #* Node.JS and Socket.IO are installed on your EC2 instance (5 points) |
− | #* The hello.txt, | + | #* The ''hello.txt'', ''brookings.jpg'', and ''city.html'' files all load successfully (3 points each) |
− | #* You can explain to the TA why phpinfo.php | + | #* Visiting a file that does not exist inside the ''static'' directory results in a 404 (3 points) |
+ | #* You can explain to the TA why ''phpinfo.php'' behaves the way it does when loaded through Node.JS (3 points) | ||
# '''File Sharing Site (40 Points):''' | # '''File Sharing Site (40 Points):''' |
Revision as of 05:14, 11 April 2013
Module 7 builds upon the JavaScript skills you learned in Module 6.
Reading
The following articles on the online class wiki textbook contain information that will help you complete the assignments.
Individual Assignments
Install Node.JS and Socket.IO
Install Node.JS from Apt or Yum according to the instructions in the Node.JS guide.
Also install Socket.IO globally (using the -g option).
Static File Server in Node.JS
The individual portion of Module 7 is short in order to give you enough time to complete the group portion.
- Copy the example code from the Node.JS guide into a file called static_server.js or something of that nature. Save it on your EC2 instance (but not in a place that Apache can serve!).
- Ensure that you understand what the static file server script is doing… this might show up on a quiz!
- Make a directory parallel to static_server.js named static.
- Change "<STATIC DIRECTORY NAME>" on line 11 of the static fileserver example code to reflect the name of the directory you just made.
- Save the following files in your static directory:
- hello.txt, a text file containing "Hello World"
- brookings.jpg, an image file you can download from here: http://classes.engineering.wustl.edu/cse330/content/brookings.jpg
- college.html, an HTML document based on the Quick and Easy HTML Layout containing an image tag pointing to brookings.jpg
- phpinfo.php, a PHP file containing the phpinfo command that generates a diagnostic page of the server:
<?php phpinfo(); ?>
- Boot up your Node.JS static fileserver, and from your browser, load all four of the files you created in step 4.
- Which ones work and which ones don't? Why might this be the case?
Group Project
In the group portion of Module 7, you will be building a multiplayer Pong game using Node.JS and Socket.IO.
If you want to reminisce and play some Pong on the command line before building it in Node.JS, here is the command, assuming you have emacs installed:
$ emacs -q --no-splash -f pong
Press C-x C-c to exit emacs.
Socket.IO Pong Game
First thing first: set up a static file server running Node.JS. We will need it in order to serve up our HTML and JavaScript content.
To start, download this file and save it in your static directory: http://classes.engineering.wustl.edu/cse330/content/pong-game.js
About the Pong-Game.JS File
We created the pong-game.js file for you to save you time and so that you can focus on the Node.JS and Socket.IO aspects of this module. This file contains the core Pong engine, but it does not establish communication between users of any kind.
If you are curious, we used the LimeJS framework as the backbone of pong-game.js. You can find the pre-compiled source code for the Pong game here:
- http://classes.engineering.wustl.edu/cse330/content/pong.js
- http://classes.engineering.wustl.edu/cse330/content/ball.js
We then used the Google Closure Compiler to compile all of the libraries you need into the one modular JavaScript file.
Just to be clear, for the purposes of Module 7, you do not need to bother with either LimeJS or Google Closure.
todo: finish
Grading
We will be grading the following aspects of your work. There are 100 points total.
- Individual Portion (20 Points):
- Node.JS and Socket.IO are installed on your EC2 instance (5 points)
- The hello.txt, brookings.jpg, and city.html files all load successfully (3 points each)
- Visiting a file that does not exist inside the static directory results in a 404 (3 points)
- You can explain to the TA why phpinfo.php behaves the way it does when loaded through Node.JS (3 points)
- File Sharing Site (40 Points):
- File Management (15 Points):
- Users can upload and delete files (4 points)
- If a file is "deleted", it should actually be removed from the filesystem (3 points)
- Existing files can be viewed (5 points)
- The directory structure is hidden (3 points)
- Image Groups (10 Points):
- An image may be associated with a group (5 points)
- All groups are listed on the home page (5 points)
- Best Practices (10 Points):
- Code is well formatted and easy to read (3 points)
- All pages pass the W3C validator (3 points)
- CSRF tokens are passed when uploading, re-categorizing, and deleting images (4 points)
- Usability (5 Points):
- Site is intuitive to use and navigate (4 points)
- Site is visually appealing (1 point)
- File Management (15 Points):
- Creative Portion (15 Points) (see below)
Creative Portion
This module, and all future modules, will require that you invest some time into creating additional features for your group project. Plan to invest at least 60 minutes of your time into the creative portion.
- The creative portion is an opportunity for you to learn material of your own interest.
- You will not earn credit for a creative-portion feature that simply rehashes something you've already done in a previous module.
If you need ideas for a creative portion, or if you want to know whether or not your creative portion idea is "hard enough", ask a TA.