YADS

Yet another document store

Store everything in one place, make connections and share it via an API.

1. Run Document Store and API

With the help of Docker, setting up this environment is a breeze.

1.1 In local environment

❯ git clone https://github.com/ixnode/yads.git && cd yads
❯ docker-compose up -d
❯ docker-compose exec yads composer install
❯ docker-compose exec yads composer reinitialize-db-prod

Start now with API Platform at http://localhost:8080/api/v1/docs.html or get all entrypoints via API:

❯ curl -s http://localhost:8080/api/v1 \
  -H 'accept: application/ld+json' | jq .

API response:

{
  "@context": "/api/v1/contexts/Entrypoint",
  "@id": "/api/v1",
  "@type": "Entrypoint",
  "document": "/api/v1/documents",
  "documentTag": "/api/v1/document_tags",
  "documentType": "/api/v1/document_types",
  "graph": "/api/v1/graphs",
  "graphRule": "/api/v1/graph_rules",
  "graphType": "/api/v1/graph_types",
  "role": "/api/v1/roles",
  "tag": "/api/v1/tags"
}

DB access

	DB	Test DB
host:	127.0.0.1	127.0.0.1
port:	`3333`	`3334`
db:	`yads`	`yads-test`
user:	`yads`	`yads`
pass:	`yads`	`yads`

❯ mysql -h127.0.0.1 -P3333 -uyads -pyads yads

❯ mysql -h127.0.0.1 -P3334 -uyads -pyads yads-test

Some command line commands

❯ docker-compose exec yads php -v
PHP 8.0.9 (cli) (built: Jul 30 2021 00:29:20) ( NTS )
Copyright (c) The PHP Group
Zend Engine v4.0.9, Copyright (c) Zend Technologies
    with Zend OPcache v8.0.9, Copyright (c), by Zend Technologies
❯ docker-compose exec yads bin/console -V
Symfony 5.3.6 (env: dev, debug: true)
❯ docker-compose exec yads composer -V
Composer version 2.1.5 2021-07-23 10:35:47

Choice / alternative

Alternatively, one can also start the Symfony server and only use the Docker database. This variant is more performant than the local Docker variant, especially on the Mac, but requires an installed Symfony client:

❯ symfony server:ca:install
❯ symfony server:start -d

Click to view the output of `symfony server:start`

 [OK] Web server listening
      The Web server is using PHP FPM 8.0.9
      https://127.0.0.1:8004


Stream the logs via symfony server:log

Depending on the output above, start now with API Platform at https://localhost:8004/api/v1/docs.html or get all entrypoints via API:

❯ curl -s https://localhost:8004/api/v1 \
  -H 'accept: application/ld+json' | jq .

1.2 Upkeep

Reinitialize db

❯ composer reinitialize-db-prod

Click to view the output of `composer reinitialize-db-prod`

 !
 ! [CAUTION] This operation should not be executed in a production environment!
 !

 Creating database schema...


 [OK] Database schema created successfully!


> bin/console doctrine:fixtures:load -n

   > purging database
   > loading App\DataFixtures\AppFixtures

2. Examples

Create `DocumentType` entity

Create `DocumentType` data

❯ vi data/json/document.type.task.json

Click to view content of `data/json/document.type.task.json`

{
  "type": "task",
  "allowedAttributes": {
    "$id": "document.data.task.schema.json",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Task document data",
    "description": "Data from document of type task",
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "title": {
        "type": "string",
        "minLength": 2,
        "maxLength": 255,
        "description": "The title of the task."
      },
      "description": {
        "type": "string",
        "minLength": 10,
        "maxLength": 65535,
        "description": "The description of the task."
      },
      "has_date_of_completion": {
        "type": "boolean"
      },
      "date_of_completion": {
        "type": "string",
        "format": "date",
        "description": "The date on which this task must be completed."
      }
    },
    "required": [
      "title",
      "description",
      "has_date_of_completion"
    ]
  },
  "defaults": [
    "title"
  ]
}

Post new `DocumentType` entity

❯ curl -X 'POST' -s \
  'https://127.0.0.1:8004/api/v1/document_types' \
  -H 'accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '@data/json/document.type.task.json' | jq .

Click to view response of POST

{
  "@context": "/api/v1/contexts/DocumentType",
  "@id": "/api/v1/document_types/1",
  "@type": "DocumentType",
  "id": 1,
  "type": "string",
  "allowedAttributes": {
    "$id": "document.data.task.schema.json",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Task document data",
    "description": "Data from document of type task",
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "title": {
        "type": "string",
        "minLength": 2,
        "maxLength": 255,
        "description": "The title of the task."
      },
      "description": {
        "type": "string",
        "minLength": 10,
        "maxLength": 65535,
        "description": "The description of the task."
      },
      "has_date_of_completion": {
        "type": "boolean"
      },
      "date_of_completion": {
        "type": "string",
        "format": "date",
        "description": "The date on which this task must be completed."
      }
    },
    "required": [
      "title",
      "description",
      "has_date_of_completion"
    ]
  },
  "defaults": [
    "title"
  ],
  "createdAt": "2021-08-04T21:03:54+00:00",
  "updatedAt": "2021-08-04T21:03:54+00:00"
}

Create `Document` entity

Create `Document` data

❯ vi data/json/document.task.json

Click to view content of `document.task.json`

{
  "data": {
    "title": "Lohnsteuererklärung einrichen",
    "description": "Die Lohnsteuererklärung muss eingereicht werden.",
    "has_date_of_completion": false
  },
  "documentType": "/api/v1/document_types/1"
}

Post new `Document` entity

❯ curl -X 'POST' -s \
  'https://127.0.0.1:8004/api/v1/documents' \
  -H 'accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '@data/json/document.task.json' | jq .

Click to view response of POST

{
  "@context": "/api/v1/contexts/Document",
  "@id": "/api/v1/documents/1",
  "@type": "Document",
  "data": {
    "title": "Lohnsteuererklärung einrichen",
    "description": "Die Lohnsteuererklärung muss eingereicht werden.",
    "has_date_of_completion": false
  },
  "documentType": "/api/v1/document_types/1",
  "id": 1,
  "createdAt": "2021-08-04T21:47:58+00:00",
  "updatedAt": "2021-08-04T21:47:58+00:00"
}

Get `Document` entities

All entities

❯ curl -s \
  'https://127.0.0.1:8004/api/v1/documents' \
  -H 'Content-Type: application/ld+json' | jq .

Click to view response of GET /api/v1/documents

{
  "@context": "/api/v1/contexts/Document",
  "@id": "/api/v1/documents",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/api/v1/documents/1",
      "@type": "Document",
      "data": {
        "title": "Lohnsteuererklärung einrichen",
        "description": "Die Lohnsteuererklärung muss eingereicht werden.",
        "has_date_of_completion": false
      },
      "documentType": "/api/v1/document_types/1",
      "id": 1,
      "createdAt": "2021-08-04T21:47:58+00:00",
      "updatedAt": "2021-08-04T21:47:58+00:00"
    }
  ],
  "hydra:totalItems": 1
}

Single entity

❯ curl -s \
  'https://127.0.0.1:8004/api/v1/documents/1' \
  -H 'Content-Type: application/ld+json' | jq .

Click to view response of GET /api/v1/documents

{
  "@context": "/api/v1/contexts/Document",
  "@id": "/api/v1/documents/1",
  "@type": "Document",
  "data": {
    "title": "Lohnsteuererklärung einrichen",
    "description": "Die Lohnsteuererklärung muss eingereicht werden.",
    "has_date_of_completion": false
  },
  "documentType": "/api/v1/document_types/1",
  "id": 1,
  "createdAt": "2021-08-04T21:47:58+00:00",
  "updatedAt": "2021-08-04T21:47:58+00:00"
}

Name		Name	Last commit message	Last commit date
Latest commit History 114 Commits
bin		bin
config		config
docker		docker
docs/images		docs/images
migrations		migrations
public		public
src		src
templates		templates
tests		tests
translations		translations
.env		.env
.env.test		.env.test
.gitignore		.gitignore
README.md		README.md
VERSION		VERSION
composer.json		composer.json
composer.lock		composer.lock
docker-compose.dev.yml		docker-compose.dev.yml
phpunit.xml.dist		phpunit.xml.dist
symfony.lock		symfony.lock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

YADS

1. Run Document Store and API

1.1 In local environment

DB access

Some command line commands

Choice / alternative

1.2 Upkeep

Reinitialize db

2. Examples

Create `DocumentType` entity

Create `DocumentType` data

Post new `DocumentType` entity

Create `Document` entity

Create `Document` data

Post new `Document` entity

Get `Document` entities

All entities

Single entity

About

Releases 7

Packages

Languages

ixnode/yads

Folders and files

Latest commit

History

Repository files navigation

YADS

1. Run Document Store and API

1.1 In local environment

DB access

Some command line commands

Choice / alternative

1.2 Upkeep

Reinitialize db

2. Examples

Create DocumentType entity

Create DocumentType data

Post new DocumentType entity

Create Document entity

Create Document data

Post new Document entity

Get Document entities

All entities

Single entity

About

Topics

Resources

Stars

Watchers

Forks

Releases 7

Packages 0

Languages

Create `DocumentType` entity

Create `DocumentType` data

Post new `DocumentType` entity

Create `Document` entity

Create `Document` data

Post new `Document` entity

Get `Document` entities

Packages