Merge pull request #1 from Rowan-ECE-Resource-Center/initial-docs

Initial docs (Update master with readme files and initial html form for frontend)

Author: thurstonian

README.md

@@ -0,0 +1,35 @@
+main-server
+---
+
+The central server used for managing the databases of the ECE Apprengineering Team at Rowan University.
+
+## backend
+Coded in Rust, manages database manipulation using AJAX requests from frontend.
+
+### Dependencies:
+* [Rouille 3.0.0](https://github.com/tomaka/rouille)
+* [Diesel 1.3.3](https://github.com/diesel-rs/diesel)
+* [dotenv 0.13.0](https://github.com/sgrif/rust-dotenv)
+* [serde 1.0](https://github.com/serde-rs/serde)
+* [serde_json 1.0](https://github.com/serde-rs/json)
+* [log 0.4](https://github.com/rust-lang-nursery/log)
+* [simplelog](https://github.com/drakulix/simplelog.rs)
+
+## frontend
+Coded in Elm, makes requests to the backend to access database and returns to the user.
+
+### Dependencies:
+* Core Elm Packages
+   * [browser](https://github.com/elm/browser)
+   * [core](https://github.com/elm/core)
+   * [html](https://github.com/elm/html)
+   * [http](https://github.com/elm/http)
+   * [json](https://github.com/elm/json)
+   * [url](https://github.com/elm/url)
+   * [bytes](https://github.com/elm/bytes)
+   * [file](https://github.com/elm/file)
+   * [time](https://github.com/elm/time)
+   * [virtual-dom](https://github.com/elm/virtual-dom)
+* [elm-json-decode-pipeline 1.0.0](https://github.com/NoRedInk/elm-json-decode-pipeline)
+* [elm-format-number 6.0.2](https://github.com/cuducos/elm-format-number)
+* [elm-round 1.0.4](https://github.com/myrho/elm-round)

backend/README.md

@@ -0,0 +1,87 @@
+## backend
+Coded in Rust, manages database manipulation using AJAX requests from frontend.
+
+### Dependencies:
+* [Rouille 3.0.0](https://github.com/tomaka/rouille)
+* [Diesel 1.3.3](https://github.com/diesel-rs/diesel)
+* [dotenv 0.13.0](https://github.com/sgrif/rust-dotenv)
+* [serde 1.0](https://github.com/serde-rs/serde)
+* [serde_json 1.0](https://github.com/serde-rs/json)
+* [log 0.4](https://github.com/rust-lang-nursery/log)
+* [simplelog](https://github.com/drakulix/simplelog.rs)
+
+
+### API Calls
+
+`GET /users`
+Gets information about every user in the system. Returns a List of Users.
+
+`GET /users/{id: u64}`
+Gets information about the user with the given id. Returns a single User.
+
+`POST /users`
+Creates a new user. The body of POST should be a valid User. Returns the id of the created user.
+
+`POST /users/{id: u64}`
+Updates a given user.
+
+### Data Models
+
+Many of the API calls share a common set of data models, represented in JSON format.
+
+#### User
+| Property Name | Type   | Optional | Description |
+|---------------|--------|----------|-------------|
+| id            | u64    | No       | The internal id of the user |
+| first_name    | String | No       | The first name of the user |
+| last_name     | String | no       | The last name of the user |
+| banner_id     | u64    | No       | The banner id of the user |
+| email         | String | Yes      | The Rowan email of the user. If the user does not have an email, this will be null of non-existent |
+```
+{
+    "id": 11,
+    "first_name": "John"
+    "last_name": "Smith",
+    "banner_id": 9162xxxxx,
+    "email": "[email protected]"
+}
+```
+
+#### Partial User
+| Property Name | Type   | Optional | Description |
+|---------------|--------|----------|-------------|
+| first_name    | String | Yes      | The first name of the user |
+| last_name     | String | Yes      | The last name of the user |
+| banner_id     | u64    | Yes      | The banner id of the user |
+| email         | String | Yes      | The Rowan email of the user. If the user does not have an email, this will be null of non-existent |
+```
+{
+    "first_name": "John"
+    "last_name": "Smith",
+    "banner_id": 9162xxxxx,
+    "email": "[email protected]"
+}
+```
+
+#### List of Users
+| Property Name | Type          | Optional | Description     |
+|---------------|---------------|----------|-----------------|
+| users         | List of Users | No       | A list of Users |
+```
+{
+    "users": [
+    {
+    "first_name": "John"
+    "last_name": "Smith",
+    "banner_id": 9162xxxxx,
+    "email": "[email protected]"
+    },
+    {
+    "first_name": "Mike"
+    "last_name": "Johnson",
+    "banner_id": 9162xxxxx,
+    "email": "[email protected]"
+    }
+    ]
+}
+```

frontend/src/form.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <script type="text/javascript">
+      function ajaxGet()
+      {
+        var xhttp = new XMLHttpRequest();
+        xhttp.open("GET", "/users/", true);
+        xhttp.send();
+        console.log(1);
+      }
+    </script>
+  </head>
+  <body>
+    <form name="databaseFrontend" onSubmit="JavaScript:ajaxGet()">
+      <input name="ajaxGet" type="submit" value="Test"
+        onClick="JavaScript:ajaxGet()">
+    </form>
+  </body>
+</html>