dennii/dbgate
1
0
Fork 0
mirror of https://github.com/DeNNiiInc/dbgate.git synced 2026-04-17 22:36:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

packages, documentation

Browse Source
This commit is contained in:
Jan Prochazka
2020-03-13 22:42:09 +01:00
parent 74e7d7d4e8
commit 0c627ea92e
5 changed files with 1621 additions and 624 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -3,7 +3,7 @@
# DbGate - database administration tool
DbGate is complete rewrite of JenaSoft [DbGate](http://www.jenasoft.com/dbgate). It uses only JavaScript (original DbGate was written in C# and TypeScript).
DbGate is complete rewrite of JenaSoft [DbGate](http://www.jenasoft.com/dbgate). It uses JavaScript and TypeScript (original DbGate was written in C# and TypeScript).
Part of this software is also port of [DbShell](https://github.com/dbshell/dbshell) from C# to JavaScript
@@ -12,23 +12,29 @@ Part of this software is also port of [DbShell](https://github.com/dbshell/dbshe
* Minimal dependencies - so that the software can be developed in future without problems with obsolete libraries
* Frontend - React, styled-components, socket.io
* Backend - NodeJs, ExpressJs, socket.io, database connection drivers
* Pure JavaScript is used (TypeScript is used only as type checker, not as compiler, so it is not mandatory part of pipeline)
* JavaScript + TypeScript
* Platform independed - will run as web application in single docker container on server, or as application using Electron platform on Linux, Windows and Mac
## How to run development environment
In one terminal, run API:
```sh
cd api
yarn
yarn start
```
In second terminal, run frontend:
If you want to make modifications in typescript packages, run TypeScript compiler in watch mode in seconds terminal:
```sh
cd web
yarn
yarn start
yarn lib
```
Open http://localhost:5000 in your browser
## Packages
* api - backend, Javascript, ExpressJS
* datalib - TypeScript library for utility classes
* electron - application (JavaScript)
* engines - drivers for database engine (mssql, mysql, postgres), analysing database structure, creating specific queries (JavaScript)
* filterparser - TypeScript library for parsing data filter expressions using parsimmon
* sqltree - JSON representation of SQL query, functions converting to SQL (TypeScript)
* types - common TypeScript definitions
* web - frontend in React (JavaScript)