Started adding docs

docs/models-services.md

@@ -0,0 +1,106 @@
+# Models and services
+
+The architecture of this web app is in general divided in two parts:
+Models and services.
+
+Services handle all "raw" requests, models contain data and methods to work with it.
+
+A service takes (in most cases) a model and returns one.
+
+## Table of Contents
+
+* [Services](#services)
+  * [Requests](#requests)
+    * [Loading](#loading)
+  * [Factories](#factories)
+  * [Before Request](#before-request)
+  * [After Request?](#after-request-)
+* [Models](#models)
+
+## Services
+
+Services are located in `src/services`.
+
+All services must inherit `AbstractService` which holds most of the methods.
+
+A basic service can look like this:
+
+```javascript
+import AbstractService from './abstractService'
+import ListModel from '../models/list'
+
+export default class ListService extends AbstractService {
+	constructor() {
+		super({
+			getAll: '/lists',
+			get: '/lists/{id}',
+			create: '/namespaces/{namespaceID}/lists',
+			update: '/lists/{id}',
+			delete: '/lists/{id}',
+		})
+	}
+	
+	modelFactory(data) {
+		return new ListModel(data)
+	}
+}
+```
+
+The `constructor` calls its parent constructor and provides the paths to make the requests. 
+The parent constructor will take these and save them in the service.
+All paths are optional. Calling a method which doesn't have a path defined will fail. 
+
+The placeholder values in the urls are replaced with the contens of variables with the same name in the 
+corresponding model (the one you pass to the functions).
+
+#### Requests
+
+Several request types are possible:
+
+| Name | HTTP Method |
+|------|-------------|
+| `get` | `GET` |
+| `getAll` | `GET` |
+| `create` | `PUT` |
+| `update` | `POST` |
+| `delete` | `DELETE` | 
+
+Each method returns a promise.
+
+Each method can take a model and optional url parameters as function parameters.
+With the exception of `getAll()`, a model is always mandatory while parameters are not.
+
+##### Loading
+
+Each service has a `loading` property, provided by `AbstractModel`.
+This property is a `boolean`, it is automatically set to `true` (with a 100ms delay to avoid flickering) 
+once the request is started and set to `false` once the request is finished.
+You can use this to show and hide a loading animation in the frontend.
+
+#### Factories
+
+The `modelFactory` takes data, and returns a model. The result of all requests (with the exception
+of the `delete` method) is run through this factory. The factory should return the appropriate model, see
+[models](#models) down below on how to handle data in models.
+
+`getAll()` checks if the response is an array, if that's the case, it will run each entry in it through
+the `modelFactory`. 
+
+It is possible to define a different factory for each request. This is done by implementing a method called 
+`model{TYPE}Factory(data)` in your service. As a fallback if the specific factory is not defined, 
+`modelFactory` will be used.
+
+#### Before Request
+
+For each request exists a `before{TYPE}(model)` method. It recieves the model, can alter it and should return
+the modified version.
+
+This is useful to make unix timestamps from javascript dates, for example.
+
+#### After Request ?
+
+There is no `after{TYPE}` method which would be called after a request is done. 
+Processing raw api data should be done in the constructor of the model, see more on that below.
+
+## Models
+