finalize readme of main project and fe and be readme adjustments

Author: 4drianMatei

README.md

@@ -2,9 +2,13 @@
 Bookmarks.dev is a bookmark manager created and designed primarily for Developers & Co. It helps you [save time and nerves
 when managing your dev bookmarks](https://dev.to/ama/how-i-manage-my-dev-bookmarks-and-save-time-and-nerves-56ae) and eases
 [bookmarking of code snippets via Codelets](https://dev.to/ama/bookmarking-code-snippets-with-codelets-3d44). Check our
-[HowTo](https://www.bookmarks.dev/howto) page to help you get started. 
+[HowTo](https://www.bookmarks.dev/howto) page to help you get started:
 
-Most worthy public bookmarks are published regularly on Github in a [separate repository](https://github.com/CodepediaOrg/bookmarks).
+ [![Save to Bookmarks.dev chrome extension usage](https://thepracticaldev.s3.amazonaws.com/i/8ukqg9jfexbohtbkv7gt.gif)](https://www.bookmarks.dev/howto)
+
+> Most worthy public bookmarks are published regularly on Github in a [separate repository](https://github.com/CodepediaOrg/bookmarks).
+
+***
 
 ## Getting started
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
@@ -14,7 +18,7 @@ The project is developed with the MEAN stack and [Keycloak](http://www.keycloak.
 
 The project contains two parts
 * [frontend](frontend) which makes up the User Interface. This uses with Angular and Angular CLI.
-* [backend](backend) which is the API supporting the UI. This uses ExpressJS with MongoDB and Keycloak.
+* [backend](backend) which is the API supporting the UI. It uses ExpressJS with MongoDB and Keycloak. See the [OpenAPI specification](https://www.bookmarks.dev/api/docs)
 
 ### Prerequisites
 
@@ -81,11 +85,47 @@ loaded with your account and you can start playing with them.
 > You can create your own test user, or any other extra users by following the screenshots in
 > [Add a Keycloak user](documentation/keycloak/add-keycloak-user.md) to create it.
 
+## Testing
+### Backend
+### Integration tests
+
+> Keycloak and mongodb have to be started as specified above (`docker-compose up` command)
+
+Run the integration test by issuing the following command.
+
+```bash
+cd backend;
+npm run integration-tests
+```
+
+A report will be generated.
+
+## Debugging
+### Frontend
+#### Dev Tools in Chromium browsers
+You can use the Dev Tools in Chromium based browsers (e.g. Chrome, Brave). Navigate to **Sources** and the file you want to set 
+your break points, like in the following example:
+
+![chrome-dev-tools-debugging](documentation/debugging/frontend/debug-frontend-chrome-dev-tools.png)
+
+#### IntelliJ
+In IntelliJ you add Javascript Debug configuration as shown below:
+
+![Intelli-frontend-debugging](documentation/debugging/frontend/debug-frontend-intellij.png)
+ 
+### Backend
+#### IntelliJ / Webstorm (Node.js plugin is required)
+The ``npm run debug`` starts nodemon with the `--inspect` parameter so you can attach to this process, by using the following configuration:
+![nodejs-remote-debugging](documentation/debugging/backend/attach-to-nodemon-process.png)
+
+
+#### Visual Studio Code
+See [Node.js debugging in VS Code with Nodemon](https://github.com/microsoft/vscode-recipes/tree/master/nodemon)
+
 ## Contributing
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 
 ## Versioning
-
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/CodepediaOrg/bookmarks.dev/tags).
 
 ## License

backend/README-backend.md

@@ -0,0 +1,31 @@
+# Backend
+Back-end REST API for [www.bookmarks.dev](http://www.bookmarks.dev).
+## OpenAPI Docs
+
+The API has an OpenAPI specification available at [docs/openapi/openapi.yaml](docs/openapi/openapi.yaml)
+
+Based on that a GUI is generated to test the API directly from browser:
+* [local](http://localhost:3000/api/docs)
+* [production](https://www.bookmarks.dev/api/docs)
+
+## Deployment
+We currently use [pm2](https://pm2.keymetrics.io/) to start the project in production.
+
+### Start
+```bash
+pm2 start pm2-process.json --env production
+```
+
+> Commited is a [pm2-process.exammple.json](pm2-process.exammple.json) example file
+
+### Restart
+```bash
+pm2 restart pm2-process.json --env production
+```
+
+### Stop
+```bash
+pm2 stop pm2-process.json --env production
+```
+
+

backend/README.md

@@ -1,18 +1,5 @@
-# Source code for bookmarks.dev - the Bookmark Manager for Developers & Co
-
-<img align="left" src="src/assets/bookmarks.dev-logo-md.png">
-
-Efficiently manage your dev bookmarks. The public and worthy ones are published on Github 
-at [https://github.com/CodepediaOrg/bookmarks](https://github.com/CodepediaOrg/bookmarks#readme)
-
- ---
-
- Built with [Angular](https://angular.io/) and [Angular CLI](https://cli.angular.io/)
- 
- ![components-graph](documentation/graphviz/components-graph.png)
- 
-> The production setup is can be found here - [components production](https://raw.githubusercontent.com/wiki/CodepediaOrg/bookmarks-api/images/network-diagram.png)
-
+# Frontend
+ The User Interface (frontend) is built with [Angular](https://angular.io/) and [Angular CLI](https://cli.angular.io/)
 
 ***
 
@@ -27,6 +14,8 @@ These instructions will get you a copy of the project up and running on your loc
 
 This project was generated with [Angular CLI](https://github.com/angular/angular-cli)
 
+> Change to the `frontend` folder before running any of the commands bellow - `cd frontend`
+
 ### Development server
 
 Run `ng serve` for a dev server. Navigate to [`http://localhost:4200/`](http://localhost:4200). The app will automatically reload if you change any of the source files.
@@ -58,12 +47,6 @@ Run `ng build` to build the project. The build artifacts will be stored in the `
 
 I use an alias for that
 ```shell
-alias bookmarks-build-aot='cd ~/projects/dev/personal/bookmarks/bookmarks.dev; rm -rf dist*; nvm use; npm run build:aot'
+alias bookmarks-build-aot='cd ~/projects/dev/personal/bookmarks/bookmarks.dev/frontend; rm -rf dist*; nvm use; npm run build:aot'
 ```
 
-## Contributing  
-Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details