Skip to content

A generic datastore accessible via REST, written in Kotlin/Ktor and backed by PostgreSQL, with a React/Redux frontend

Notifications You must be signed in to change notification settings

kesslern/ascient

Repository files navigation

Ascient

A backend and frontend for storing generic data. Exposes an secure REST API usable by web applications, scripts, IoT devices, or any other HTTP capable device. An example frontend is provided to consume this data.

Running the Project

Build and run with docker:

docker-compose build
docker-compose up [--detach]

Default Ports and Users

Service Port Username Password
ascient-backend 8081 admin password
ascient-frontend 8080 admin password
postgres 5432 user pass

Supported Datatypes

  • Booleans

Planned Datatypes

  • Lists
    • Queue manipulation methods
    • Stack manipulation methods
  • Numbers
    • Counters
    • Arbitrary math statements
    • Stored math events
  • Strings

Features

  • User-based data storage
  • Store creation time and last modification time
  • Authenticate with session or username/password for any endpoint

Planned Fetaures

  • Change data periodically
    • Set or toggle boolean after a time period
    • Set or toggle a boolean at a specified time
  • Create new users
  • Change admin password on first login
  • Ability to delete users as admin
    • Include associated data
  • Real-time data updates via websockets (show changes from other users)

Other Todo

  • Change all POSTs to use JSON bodies instead of query parameters
  • Configurable ports and default usernames

License

ISC License

Copyright 2019 Nathan Kessler

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.