https://github.com/mubaidr/citus-data-starter
A template for Citus Data Community edition. Worry-free Postgres that scales out...
https://github.com/mubaidr/citus-data-starter
citus citusdb docker docker-compose postgres postgres-database scale template
Last synced: 5 months ago
JSON representation
A template for Citus Data Community edition. Worry-free Postgres that scales out...
- Host: GitHub
- URL: https://github.com/mubaidr/citus-data-starter
- Owner: mubaidr
- License: apache-2.0
- Created: 2020-07-09T20:52:57.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-01T20:32:35.000Z (10 months ago)
- Last Synced: 2024-12-01T03:14:49.710Z (7 months ago)
- Topics: citus, citusdb, docker, docker-compose, postgres, postgres-database, scale, template
- Language: Shell
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Citus-Data-Starter
A template for quickly developing using Citus Data Community edition. Worry-free Postgres that scales out...
## Table of Contents
- [Features](#features)
- [Used Technology Stack](#used-technology-stack)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
## Features
- [Docker](https://www.docker.com) based setup
- [Citus Data](https://www.citusdata.com)
- [PgAdmin](https://www.pgadmin.org)
- [PgHero](https://github.com/ankane/pghero) dashboard
- Schema setup on startup
- Sample scripts in `citus/schema` directory
- Common extensions for Citus Data installed
- `btree_gist`
- `postgres-json-schema`
- `periods`
- `pg_stat_statements`
- `pgcrypto`
- `uuid-ossp`
- `fuzzystrmatch`
- `hll`
- `pg_prewarm`
- `hypopg`
- `hstore`
- `pg_trgm`
- `pg_repack`
- `moddatetime`
- `topn`
## Prerequisites
- [Docker](https://www.docker.com) based setup
- and thats is
## Getting started
- Clone this repository `git clone https://github.com/mubaidr/citus-data-starter`
- Update `.env` configuraiton (`.env.example` available)
- Run using
- `make run`
or
- `docker-compose --file docker-compose.dev.yml up`
## Issues and Contribution
Want to file a bug, contribute some code, or improve documentation? Excellent! Please make sure to check existing issues before opening a new one.
## Where to find me
Twitter: [@mubaidr](https://twitter.com/mubaidr)