# LocalData API

LocalData API is a self-hosted databases app. LocalData API lets developers simulate Amazon cloud database services locally so they can build and test applications offline before connecting to real cloud systems. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/5392/localdata-api

## Description

LocalData API lets developers simulate Amazon cloud database services locally so they can build and test applications offline before connecting to real cloud systems.

## Platform availability

Available on 0 of 9 platforms.

## Health score

14/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (last commit 3750 days ago)
- Popular: 26 (20 GitHub stars)
- Easy to install: 25 (0 install platforms, install notes, Docker image)

## Links

- GitHub: https://github.com/LocalData/localdata-api
- Docker Hub: https://hub.docker.com/r/koxudaxi/local-data-api
- Official website: http://localdata.com/

## Common questions

### How do I start the LocalData API and use a different environment file?

Run npm install, put your configuration in a .env file based on sample.env, then start it with node_modules/.bin/envrun node lib/server.js. For a separate file, run node_modules/.bin/envrun -e remote-db.env node lib/server.js.

### How do I connect a hosted dashboard and mobile app to the API?

Host local copies of the dashboard and mobile app, then set REMOTE_MOBILE_PREFIX and REMOTE_ADMIN_PREFIX to point to those installs.

### How do I simulate a live deployment with HTTPS?

Use the bin/fakeroku script, for example PORT=3443 bin/fakeroku 3000, to handle HTTPS and forward requests to the LocalData API. It expects the key and certificate in ~/.ssh/localdata-key.pem and ~/.ssh/localdata-cert.pem, so import the certificate or allow the self-signed certificate in your browser.

### What do I need to run the API tests for the first time?

Generate self-signed certificates with openssl, then run make test. On first use, create a PostgreSQL/PostGIS database with base feature data and import test/data/features-db.sql using psql.

## Alternatives

- Harvester: Harvester is the next generation of open-source hyperconverged infrastructure solutions designed for modern cloud-native environments.
- MOS (Modular Operating System): MOS is a lightweight operating system based on Devuan, designed specifically for small, energy-efficient home servers.
- Microsoft Hyper-V Server: Microsoft Hyper-V Server is a free product that delivers enterprise-class virtualization for your datacenter and hybrid cloud.
- StableBit DrivePool: State of the art, file based drive pooling software.
- TrueNAS: TrueNAS (formerly FreeNAS) is an operating system that can be installed on virtually any hardware platform to share data over a network.
- Western Digital My Cloud: Western Digital My Cloud is an easy-to-use personal cloud storage device that plugs directly into your Wi-Fi router at home so you can pres…
- XigmaNAS: XigmaNAS (formerly NAS4Free) is an embedded Open Source Storage NAS (Network-Attached Storage) distribution based on FreeBSD.
- ZimaOS: A simplified, focused and open NAS OS that supports all X86-64 hardware.
- openmediavault: OpenMediaVault turns an old computer or Raspberry Pi into your own private cloud storage.
- unraid-api

---
Source: Our Local Host (https://ourlocalhost.com/app/5392/localdata-api), the self-hosted and open-source app directory.