CODEU CHAT SERVER | README

DISCLAIMER

CODEU is a program created by Google to develop the skills of future software engineers. This project is not an offical Google Product. This project is a playground for those looking to develop their coding and software engineering skills.

ENVIRONMENT

All instructions here are relative to a LINUX environment. There will be some differences if you are working on a non-LINUX system. We will not support any other development environment.

This project was built using JAVA 7. It is recommended that you install JAVA 7 when working with this project.

GETTING STARTED

To build the project:
```
$ sh clean.sh
$ sh make.sh
```
To test the project:
```
$ sh test.sh
```
To run the project you will need to run both the client and the server. Run the following two commands in separate shells:
```
$ sh run_server.sh
$ sh run_client.sh
```
The run_server and run_client scripts have hard-coded addresses for your local machine. If you are running the server on a different machine than the client, you will need to change the host portion of the address in run_client.sh to the name of the host where your server is running. Make sure the client and server are using the same port number.

All running images write informational and exceptional events to log files. The default setting for log messages is "INFO". You may change this to get more or fewer messages, and you are encouraged to add more LOG statements to the code. The logging is implemented in codeu.chat.util.Logger.java, which is built on top of java.util.logging.Logger, which you can refer to for more information.

In addition to your team's client and server, the project also includes a Relay Server and a script that runs it (run_relay.sh). This is not needed to get started with the project.

Finding your way around the project

All the source files (except test-related source files) are in ./src/codeu/chat. The test source files are in ./test/codeu/chat. If you use the supplied scripts to build the project, the .class files will be placed in ./bin. There is a ./third_party directory that holds the jar files for JUnit (a Java testing framework). Your environment may or may not already have this installed. The supplied scripts use the version in ./third_party.

Finally, there are some high-level design documents in the project Wiki. Please review them as they can help you find your way around the sources.

Source Directories

The major project components have been separated into their own packages. The main packages/directories under src/codeu/chat are:

codeu.chat.client

Classes for building the two clients (codeu.chat.ClientMain and codeu.chat.SimpleGuiClientMain).