{"id":21769443,"url":"https://github.com/prostgles/ui","last_synced_at":"2025-10-04T21:23:47.940Z","repository":{"id":40198965,"uuid":"445790497","full_name":"prostgles/ui","owner":"prostgles","description":"PostgreSQL Editor and Dashboard","archived":false,"fork":false,"pushed_at":"2025-03-27T17:30:06.000Z","size":78606,"stargazers_count":154,"open_issues_count":6,"forks_count":11,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-29T08:07:16.174Z","etag":null,"topics":["dashboard","mobile","postgis","postgres","postgresql","realtime","sql","websockets"],"latest_commit_sha":null,"homepage":"https://prostgles.com/ui","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prostgles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-08T10:38:19.000Z","updated_at":"2025-03-28T02:42:10.000Z","dependencies_parsed_at":"2023-12-17T20:43:56.794Z","dependency_job_id":"924f1848-e444-4858-adfc-d1a903859d95","html_url":"https://github.com/prostgles/ui","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prostgles%2Fui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prostgles%2Fui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prostgles%2Fui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prostgles%2Fui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prostgles","download_url":"https://codeload.github.com/prostgles/ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312078,"owners_count":20918344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","mobile","postgis","postgres","postgresql","realtime","sql","websockets"],"created_at":"2024-11-26T14:08:48.628Z","updated_at":"2025-10-04T21:23:47.933Z","avatar_url":"https://github.com/prostgles.png","language":"TypeScript","readme":"# Prostgles UI\n\nSQL Editor and internal tool builder for Postgres\n\n[Live demo](https://playground.prostgles.com/)\n\n### Screenshots\n\n[More](https://prostgles.com/ui)\n\n\u003cp float=\"left\"\u003e\n  \u003cimg src=\"https://prostgles.com/static/images/screenshot_crypto.png\" width=\"100%\"/\u003e  \n\u003c/p\u003e\n\n### Features\n\n- SQL Editor with context-aware schema auto-completion and documentation extracts and hints\n- Realtime data exploration dashboard with versatile layout system (tab and side-by-side view)\n- Table view with controls to view related data, sort, filter and cross-filter\n- Map and Time charts with aggregations\n- Data insert/update forms with autocomplete\n- Role based access control rules\n- Isomorphic TypeScript API with schema types, end to end type safety and React hooks\n- File upload (locally or to cloud)\n- Search all tables from public schema\n- Media file display (audio/video/image/html/svg)\n- Data import (CSV, JSON and GeoJSON)\n- Backup/Restore (locally or to cloud)\n- TypeScript server-side functions (experimental)\n- Mobile friendly\n- LISTEN NOTIFY support\n\n### Installation - Docker compose (recommended)\n\nDownload the source code:\n\n```bash\ngit clone https://github.com/prostgles/ui.git\ncd ui\n```\n\nDocker setup. By default the app will be accessible at [localhost:3004](http://localhost:3004)\n\n```docker-compose.sh\ndocker compose up -d\n```\n\nTo use a custom port (3099 for example) and/or a custom binding address (0.0.0.0 for example):\n\n```bash\nPRGL_DOCKER_IP=0.0.0.0 PRGL_DOCKER_PORT=3099 docker compose up\n```\n\n### Installation - use existing PostgreSQL instance\n\nUse this method if you want to use your existing database to store Prostgles metadata\n\nDownload the source code:\n\n```bash\ngit clone https://github.com/prostgles/ui.git prostgles\ncd prostgles\n```\n\nBuild and run our docker image (172.17.0.1 is used to connect to localhost):\n\n```docker-run.sh\ndocker build -t prostgles .\ndocker run -d -p 127.0.0.1:3004:3004 \\\n  -e POSTGRES_HOST=172.17.0.1 \\\n  -e POSTGRES_PORT=5432 \\\n  -e POSTGRES_DB=postgres \\\n  -e POSTGRES_USER=postgres \\\n  -e POSTGRES_PASSWORD=postgres \\\n  -e PROSTGLES_UI_HOST=0.0.0.0 \\\n  -e IS_DOCKER=yes \\\n  -e NODE_ENV=production \\\n  prostgles\n\n```\n\nYour server will be running on [localhost:3004](http://localhost:3004).\n\n### Development\n\n#### 1. Install dependencies:\n\n- [NodeJS](https://nodejs.org/en/download)\n- [Postgres](https://www.postgresql.org/download/): For full features **postgresql-15-postgis-3** is recommended\n\n#### 2. Create a database and user update `.env`. All prostgles state and metadata will be stored in this database\n\n    sudo su - postgres\n    createuser --superuser usr\n    psql -c \"alter user usr with encrypted password 'psw'\"\n    createdb db -O usr\n\n#### 3. Start app in dev mode (will install npm packages)\n\n    npm run dev\n\n### Testing\n\nEnsure the app is running in development mode and:\n\n    cd e2e \u0026\u0026 npm test-local\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprostgles%2Fui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprostgles%2Fui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprostgles%2Fui/lists"}