/key-value-store

Primary LanguagePHP

Version Controlled Key-Value Store

Requirements

  • PHP 8.0
  • mysql

Getting started

Installation

Please check the official laravel installation guide for server requirements before you start. Official Documentation

Clone the repository

git clone git@github.com:erisitohang/key-value-store.git

Switch to the repo folder

cd key-value-store

Install all the dependencies using composer

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Start the local development server

php artisan serve

Docker

To install with Docker, run following commands:

git clone git@github.com:erisitohang/key-value-store.git
cd key-value-store
cp .env.example.docker .env

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/var/www/html \
    -w /var/www/html \
    laravelsail/php80-composer:latest \
    composer install --ignore-platform-reqs

./vendor/bin/sail up -d
./vendor/bin/sail artisan key:generate
./vendor/bin/sail artisan migrate

Run Test

php artisan test

Endpoints:

Add object:

POST /object

Example request body:

{
    "mykey": "mykey_value"
}

Get object:

GET /object/mykey

Example response:

{
    "mykey": "mykey_value"
}

GET /object/mykey?timestamp=1440568980

Example response:

{
    "mykey": "mykey_value"
}

Get all objects:

GET /object/get_all_records

Example response:

[
    {
        "mykey": "mykey_value"
    }
]