DOC: update documentation (#130)

* DOC: update documentation

* DOC: update more docs

* DOC: update test script

* DOC: update expected output

Author: eigenfoo

Makefile

@@ -27,7 +27,7 @@ backend:  # Package Spotify Apollo service with maven.
 
 storage:  # Initialize filesystemm and database and pre-populate with examples. Requires MySQL root password.
 	mkdir -p ~/.euphoria
-	cp -r docs/exampleFiles/* ~/.euphoria/
+	cp -r docs/example-files/* ~/.euphoria/
 	cat euphoria-service/src/main/resources/initialize-database.sql | mysql -u root -p
 
 build: frontend backend  # Alias for `make frontend backend`.

README.md

@@ -3,9 +3,9 @@
 [![Build Status](https://travis-ci.org/eigenfoo/euphoria.svg?branch=master)](https://travis-ci.org/eigenfoo/euphoria)
 
 > Our web application is served at
-> [199.98.27.117:8000](http://199.98.27.117:8000/). We eventually intend to set
-> up the [euphoria-recruiting.club](http://euphoria-recruiting.club/) domain
-> name (hence the project structure).
+> [199.98.27.117:8000](http://199.98.27.117:8000/). We intended to set up the
+> [euphoria-recruiting.club](http://euphoria-recruiting.club/) domain name
+> (hence the project structure), but that fell outside the scope of our project.
 
 A simple recruiting platform, written as a project for ECE366 (Software
 Engineering & Large Systems Design) at The Cooper Union. Euphoria's tech stack
@@ -14,14 +14,16 @@ with a [MySQL](https://www.mysql.com/) database and a
 [React.js](https://github.com/facebook/create-react-app) JavaScript web
 application. 
 
-Team members: [George Ho](https://github.com/eigenfoo), [Wendy Ide](https://github.com/wside), [Luka Lipovac](https://github.com/lipovac) and [Ostap Voynarovskiy](https://github.com/ostapstephan)
+Team members: [George Ho](https://github.com/eigenfoo), [Wendy
+Ide](https://github.com/wside), [Luka Lipovac](https://github.com/lipovac) and
+[Ostap Voynarovskiy](https://github.com/ostapstephan)
 
 ## Requirements
 
 - [Oracle JDK 11](https://www.oracle.com/technetwork/java/javase/downloads/jdk11-downloads-5066655.html)
 - Maven
 - MySQL
-- Node.js and `npm`
+- Node.js and npm
 
 ```bash
 sudo apt install nodejs npm maven mysql-server
@@ -39,14 +41,20 @@ make all
 
 This will:
 
-1. Install `euphoria`'s dependencies
-2. Build the frontend web application and backend service
+1. Install euphoria's dependencies.
+2. Build the frontend web application with npm and package the backend service
+   with maven.
 3. Initialize the filesytem and database, and pre-populate it with examples.
 
 See the [installation and setup
 documentation](https://github.com/eigenfoo/euphoria/blob/master/docs/installation-setup.md)
 for more detailed instructions on how to manually install and setup `euphoria`.
 
+## Deployment
+
+Upon running `make all`, you can simply run `make deploy` in a virtual machine
+to deploy euphoria.
+
 ## Documentation
 
 See the [`docs/`

docs/exampleFiles/app_1/cover_1.pdf docs/example-files/app_1/cover_1.pdf

@@ -130,6 +130,7 @@
     Payload contains nothing.
 
 ---
+
 To base64 dump any file:
 ```bash
 base64 resume.pdf | tr -d '\n'

docs/exampleFiles/app_1/resume_1.pdf docs/example-files/app_1/resume_1.pdf

@@ -14,14 +14,14 @@
     ```
 
 3. Initiliaze the example files by manually copying the contents of
-   [`docs/exampleFiles`
-   subdirectory](https://github.com/eigenfoo/euphoria/tree/master/docs/exampleFiles)
+   [`docs/example-files`
+   subdirectory](https://github.com/eigenfoo/euphoria/tree/master/docs/example-files)
    into `~/.euphoria/`. You will need to manually create the `~/.euphoria`
    directory.
 
    ```bash
    mkdir ~/.euphoria/
-   cp -r docs/exampleFiles/* ~/.euphoria/
+   cp -r docs/example-files/* ~/.euphoria/
    ```
 
 4. Download dependencies for, and build, the frontend:
@@ -49,7 +49,7 @@
 5. If serving the frontend on a virtual machine, overwrite the file
    `/etc/nginx/sites-available/default` with [the `nginx/default`
    file](https://github.com/eigenfoo/euphoria/blob/master/nginx/default). Then
-   restart `nginx` with `sudo /etc/init.d/nginx reload`.
+   restart `nginx` with `sudo systemctl restart nginx`.
 
    Before restarting `nginx`, you can test your configuration with `sudo nginx
    -t`.

docs/exampleFiles/app_2/cover_2.pdf docs/example-files/app_2/cover_2.pdf

@@ -0,0 +1,86 @@
+#!/bin/bash
+#
+# This script sends test HTTP requests from the command line via curl. Expected
+# outputs are documented in `http-expected-output.txt`. Note that the expected
+# outputs are produced by running this script immediately after initializing the
+# database (with `initialize-database.sql`). Also note that some outputs are
+# non-deterministic and will change (e.g. the cookie that is produced upon
+# authentication).
+
+curl -X GET http://localhost:8080/api/authentication/apple/hash
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/1
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/all
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/random
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/company/123
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/NEWYORK/TECHNOLOGY/INTERNSHIP
+echo ""
+
+curl -X GET http://localhost:8080/api/application/1
+echo ""
+
+curl -X GET http://localhost:8080/api/application/posting/3
+echo ""
+
+curl -X GET http://localhost:8080/api/user/2
+echo ""
+
+curl -X GET http://localhost:8080/api/company/2
+echo ""
+
+curl -X POST http://localhost:8080/api/authentication -H "Content-Type: application/json" -d '{"id": 3, "username": "george", "passwordHash":"ho", "isUser" : true}'
+echo ""
+
+curl -X GET http://localhost:8080/api/authentication/george/ho
+echo ""
+
+curl -X POST http://localhost:8080/api/posting -H "Content-Type: application/json" -d '{"companyId": 5, "jobTitle": "hello", "description":"there", "location" : "NEWYORK" , "industry": "FINANCE", "skillLevel":"INTERNSHIP"}'
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/4
+echo ""
+
+curl -X POST http://localhost:8080/api/application -H "Content-Type: application/json" -d '{"postingId": 3, "userId": 2, "resume": "54686973", "coverLetter": "54686973"}'
+echo ""
+
+curl -X POST http://localhost:8080/api/application -H "Content-Type: application/json" -d '{"postingId": 1, "userId": 1, "resume": "This", "coverLetter": "This"}'
+echo ""
+
+curl -X GET http://localhost:8080/api/application/4
+echo ""
+
+curl -X POST http://localhost:8080/api/user -H "Content-Type: application/json" -d '{"name": "george", "email": "[email protected]", "phoneNumber": "1234567890", "educationLevel": "BACHELORS", "description": "fml."}'
+echo ""
+
+curl -X GET http://localhost:8080/api/user/4
+echo ""
+
+curl -X POST http://localhost:8080/api/company -H "Content-Type: application/json" -d '{"name": "Cooper", "website": "cooper.edu", "description": "fml."}'
+echo ""
+
+curl -X PUT http://localhost:8080/api/posting -H "Content-Type: application/json" -d '{"postingId": 4, "jobTitle": "again hello", "description":"there", "location" : "NEWYORK" , "industry": "FINANCE", "skillLevel":"INTERNSHIP"}'
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/4
+echo ""
+
+curl -X DELETE http://localhost:8080/api/posting/4
+echo ""
+
+curl -X GET http://localhost:8080/api/posting/4
+echo ""
+
+curl -X POST http://localhost:8080/api/cookie -H "Content-Type: application/json" -d '{"username": "timapple", "passwordHash": "hash"}'
+echo ""
+
+curl -X GET http://localhost:8080/api/cookie/abcdefgh-ijkl-mnop-qurs-tuvwxyz12345
+echo ""