diff --git a/README.md b/README.md index 89b278ae3..ac33eee78 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,31 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +# DbGate - database administration tool -## Available Scripts +DbGate is complete rewrite of JenaSoft [DbGate](http://www.jenasoft.com/dbgate). It uses only JavaScript (original DbGate was written in C# and TypeScript). -In the project directory, you can run: +Part of this software is also port of [DbShell](https://github.com/dbshell/dbshell) from C# to JavaScript -### `yarn start` +## Design goals +* Application simplicity - DbGate takes the best and only the best from old DbGate, [DatAdmin](http://www.jenasoft.com/datadmin) and [DbMouse](http://www.jenasoft.com/dbmouse) . First will be implemented the most used features from this software. +* 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) +* Platform independed - will run as web application in single docker container on server, or as application using Electron platform on Linx, Windows and Mac -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +## How to run development environment -The page will reload if you make edits.
-You will also see any lint errors in the console. +In one terminal, run API: +```sh +cd api +yarn +yarn start +``` -### `yarn test` +In second terminal, run frontend: +```sh +cd web +yarn +yarn start +``` -Launches the test runner in the interactive watch mode.
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. - -### `yarn build` - -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `yarn eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting - -### Analyzing the Bundle Size - -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size - -### Making a Progressive Web App - -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app - -### Advanced Configuration - -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration - -### Deployment - -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment - -### `yarn build` fails to minify - -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify +Open http://localhost:5000 in your browser