articles-api/README.md

# xdrm go framework

### 1. Setup

All commands above must be launched from the root of this repository.

In order for next steps to work properly whatever your configuration, you might execute the following command:
```bash
chmod +x $GOPATH/src/git.xdrm.io/go/xb-api/*.sh
```

### 2. Build type checkers

Default types have to be built before using them.

```bash
$GOPATH/src/git.xdrm.io/go/xb-api/build-types.sh
```

If the build process succeeds, the `./types` folder must contain *.so* files.

### 3. Build controllers

Controllers are located under the `./root` file structure.

```bash
$GOPATH/src/git.xdrm.io/go/xb-api/build-controllers.sh ./root
```

If the build process succeeds, the `./controllers` folder must contain *.so* files.

### 4. Launch the api

```
$ go run ./cmd/test/main.go
```