# OKCMS

> "Pretty good"
>
> - Steve Jobs

## To run the demo:

- npm install
- cd examples
- node index

Server will be running on http://lvh.me:1337/

Admin area available on http://lvh.me:1337/admin/

## Config

To access the admin area, you need to set a username and password.
To do that create a file called `.env` in the project directory with
the following contents:

```
OK_USER=username
OK_PASS=password
```

S3 needs to be configured in the same way:

```
S3_KEY=s3key
S3_SECRET=s3secret
S3_BUCKET=bucketname
```

## Deploy

Every OKCMS install is deployed with pm2.

`pm2 start index.js --name [id]`

`pm2 restart [id]`

`pm2 logs`

to see logs and

`pm2 list`

to see running processes and

`pm2 show [id]`

for more process info.

## Schema

Valid datatypes include:

- string
- text
- number
- enum
- foreign-key
- video
- image
- date
- flag
- tag-list
- link-list
- media-list
- captioned-image-list
- double-captioned-image-list
- meta

### Notes

- ALL records should have a title. this is used to generate the ID.
- add an `alias` attribute to retitle fields in the admin view
- foreign keys: list `key` attribute pointing at the other table

### Dashboard resources

```
      dashboard: {
        resources: {
          flour: {
            display: "image",
          },
          bread: {
            title: "type",
            subtitle: "title",
          },
          artwork: {
            groupBy: "artist",
          },
        },
      },
```

## Local S3

If you don't want to use S3 and you have enough disk space locally, you can just write them locally. Supply these options to the S3 service configuration (pathss with trailing slash!).

```
local: {
  localPath: "/home/username/my-cool-website-pro/public/local-files/",
  remotePath: "/local-files/",
},
```