Module5-AI

Module 5 builds upon the JavaScript skills you learned in Module 4.

Reading

The following articles on the online class wiki textbook contain information that will help you complete the assignments.

• Node.JS
• Socket.IO
• FAQ - Mod 6

Individual Assignments

Install Node.JS

Install Node.JS from Apt or Yum according to the instructions in the Node.JS guide.

Static File Server in Node.JS

The individual portion of Module 5 is short in order to give you enough time to complete the group portion.

1. 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…

2. Make a directory parallel to static_server.js named static.
3. Change "<STATIC DIRECTORY NAME>" on line 11 of the static fileserver example code to reflect the name of the directory you just made.
4. 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();   ?>
   

5. 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 5 you will create a multi-room chat server using Node.JS and Socket.IO. This project must be completed using Node.JS.

This chat service will contain a main lobby where users sign on with a nickname and can communicate with each other. Users may also create chat rooms for other to join. The entire app should be displayed on a single webpage, listing the room you are in, all available rooms, and the users in the current room.

The single room chat server and client are provided here: Socket.IO

Agent: AI Extension

In this section, you’ll enhance your multi-room chat server with an **AI assistant** powered by your choice of model. You can choose whichever option you prefer. For most students, **Ollama** is recommended as it runs locally and is free. Go to https://ollama.com/ and click models to see all of the models available. Also, https://huggingface.co/ is a great place to find open-source models. Other popular options include **OpenAI**, **Gemini**, and similar APIs (note that most cloud options do not have a free tier). If you have question about a specific model ask a TA.

Overview

This extension allows any user in a chat room to message an AI bot by typing a command like:

``` \agent What is the capital of France? ```

The server captures messages that begin with `\agent`, forwards the prompt to your chosen model, and returns the generated reply to everyone in the same room as **Agent**.

You are welcome to use any AI helper to complete this extension. If you choose to use an API, you need to obtain an API key and store it in a file named `.env` at the root of your project, for example:

``` OPENAI_API_KEY=your_key_here ```

Your server code should then load it securely with:

```js import 'dotenv/config'; ```

See your selected API’s documentation for instructions on obtaining and using keys. Feel free to use your favorite AI helper to compelte this portion.

Grading

We will be grading the following aspects of your work. There are 75 points total.

Assignments (including code) must be committed to Github by the end of class on the due date (commit early and often). Failing to commit by the end of class on the due date will result in a 0.

Additionally, for this module, the TA should be able to simply download your repo and start up your file server, without having to copy files or create additional subdirectories. This applies to both the individual and the creative portion

Grading

We will be grading the following aspects of your work. There are 75 points total.

Assignments (including code) must be committed to Github by the end of class on the due date (commit early and often). Failing to commit by the end of class on the due date will result in a 0.

Additionally, for this module, the TA should be able to simply download your repo and start up your file server, without having to copy files or create additional subdirectories. This applies to both the individual and the creative portion

_________

1. Individual Portion (25 Points):
   • Node.JS is installed on your EC2 instance (5 points)

     Take a screenshot of your browser visiting your EC2 instance serving up the college.html web page on port 3456, make sure the URL is visible in the screenshot.

   • The hello.txt, brookings.jpg, and college.html files all load successfully (4 points each)
   • Visiting a file that does not exist inside the static directory results in a 404 (4 points)
   • Discuss in the README.md why phpinfo.php behaves the way it does when loaded through Node.JS (4 points)
   • Make sure all of your individual portion files are pushed to Github (include your node.js files, hello.txt, brookings.jpg, college.html, and phpinfo.php)

1. Multi-room Chat Server (50 Points):
   • Administration of user created chat rooms (25 Points):
     • Users can create chat rooms with an arbitrary room name(5 points)
     • Users can join an arbitrary chat room (5 points)
     • The chat room displays all users currently in the room (5 points)
     • A private room can be created that is password protected (5 points)
     • Creators of chat rooms can temporarily kick others out of the room (3 points)
     • Creators of chat rooms can permanently ban users from joining that particular room (2 points)
   • Messaging (5 Points):
     • A user's message shows their username and is sent to everyone in the room (1 point)
     • Users can send private messages to another user in the same room (4 points)
   • AI Agent (15 Points)
   • Implement an AI assistant accessible via the command \agent ... that replies in the current room (10 points)
   • Handles basic errors gracefully and does not crash the server (5 point)
   • Best Practices (5 Points):
     • Code is well formatted and easy to read, with proper commenting (2 points)
     • Code passes HTML validation (2 points)
     • node_modules folder is ignored by version control (1 points)
   • Usability (5 Points):
     • Communicating with others and joining rooms is easy and intuitive (4 points)
     • Site is visually appealing (1 point)
   • Creative Portion (10 Points)