docs: added NPM commands to README

- also removed some commands which are not needed from package.json

Author: Maksym Mykhailenko

README.md

@@ -12,6 +12,7 @@ Microservice to manage CRUD operations for all things Projects.
       - [📤 Export data](#%f0%9f%93%a4-export-data)
       - [📥 Import data](#%f0%9f%93%a5-import-data)
     - [Run Connect App with Project Service locally](#run-connect-app-with-project-service-locally)
+    - [NPM Commands](#npm-commands)
     - [Import metadata from api.topcoder-dev.com (deprecated)](#import-metadata-from-apitopcoder-devcom-deprecated)
   - [Test](#test)
     - [JWT Authentication](#jwt-authentication)
@@ -67,13 +68,13 @@ Local setup should work good on **Linux** and **macOS**. But **Windows** is not
 3. 🚢 Start docker-compose with services which are required to start Project Service locally
 
    ```bash
-   npm run local:run-docker
+   npm run local:docker:up
    ```
 
    Wait until all containers are fully started. As a good indicator, wait until `project-processor-es` successfully started by viewing its logs:
 
    ```bash
-   docker-compose -f local/full/docker-compose.yml logs -f project-processor-es
+   npm run local:docker:logs -- -f project-processor-es
    ```
 
    <details><summary>Click to see a good logs example</summary>
@@ -242,6 +243,32 @@ To be able to run [Connect App](https://github.com/appirio-tech/connect-app) wit
 
 2. Restart both Connect App and Project Service if they were running.
 
+### NPM Commands
+
+| Command&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description |
+|--------------------|--|
+| `npm run lint`     | Check for for lint errors. |
+| `npm run lint:fix` | Check for for lint errors and fix error automatically when possible. |
+| `npm run build`    | Build source code for production run into `dist` folder. |
+| `npm run sync:all` | Recreate Database and Elasticsearch indexes (removes any existent data). |
+| `npm run sync:db`  | Recreate Database schemas (removes any existent data). |
+| `npm run sync:es`  | Recreate Elasticsearch indexes (removes any existent data). |
+| `npm run start`  | Start app in the production mode from prebuilt `dist` folder. |
+| `npm run start:dev`  | Start app in the development mode using `nodemon`. |
+| `npm run test`  | Run tests. |
+| `npm run test:watch`  | Run tests and re-run them on changes (not useful now as it re-runs all the test). |
+| `npm run demo-data`  | Import Metadata from DEV environment, see [docs](#import-metadata-from-apitopcoder-devcom-deprecated). |
+| `npm run es-db-compare`  | Run helper script to compare data in Database and Elasticsearch indexes, see [docs](./scripts/es-db-compare/README.md). |
+| `npm run data:export`  | Export data from Database to file, see [docs](#📤-export-data) |
+| `npm run data:import`  | Import data from file to Database and index it to Elasticsearch, see [docs](#📥-import-data) |
+| `npm run local:docker:up`  | Start docker-compose for local development. |
+| `npm run local:docker:down`  | Stop docker-compose for local development. |
+| `npm run local:docker:logs -- -f <service_name>`  | View logs of some service inside docker-compose. |
+| `npm run local:init`  | Recreate Database and Elasticsearch indexes and populate demo data for local development (removes any existent data). |
+| `npm run generate:doc:permissions` | Generate [permissions.html](docs/permissions.html) which later can be viewed by [link](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html). |
+| `npm run generate:doc:permissions:dev` | Generate [permissions.html](docs/permissions.html) on any changes (useful during development). |
+
+
 ### Import metadata from api.topcoder-dev.com (deprecated)
 
 ```bash
@@ -314,4 +341,4 @@ docker exec -it tc-projects-kafka /opt/kafka/bin/kafka-console-producer.sh --bro
 
 ## References
 
-- [Projects Service Architecture](./docs/guides/architercture/architecture.md)
+- [Projects Service Architecture](./docs/guides/architercture/architecture.md)

package.json

@@ -13,11 +13,6 @@
     "sync:all": "NODE_ENV=development npm run sync:db && NODE_ENV=development npm run sync:es",
     "sync:db": "./node_modules/.bin/babel-node migrations/sync.js",
     "sync:es": "./node_modules/.bin/babel-node migrations/elasticsearch_sync.js",
-    "sync:es:metadata": "./node_modules/.bin/babel-node migrations/elasticsearch_sync.js --index-name metadata",
-    "migrate:es": "./node_modules/.bin/babel-node migrations/seedElasticsearchIndex.js",
-    "migrate:es:metadata": "./node_modules/.bin/babel-node migrations/helpers/indexMetadataDirectly.js",
-    "migrate:bookmarks": "./node_modules/.bin/babel-node migrations/bookmarks/migrateBookmarksToLinks.js",
-    "migrate:bookmarks:revert": "./node_modules/.bin/babel-node migrations/bookmarks/migrateLinksToBookmarks.js",
     "prestart": "npm run -s build",
     "start": "node dist",
     "start:dev": "NODE_ENV=development PORT=8001 nodemon -w src --exec \"node --require dotenv/config --require babel-core/register src\" | ./node_modules/.bin/bunyan",
@@ -29,7 +24,9 @@
     "es-db-compare": "babel-node scripts/es-db-compare",
     "data:export": "NODE_ENV=development LOG_LEVEL=info node --require dotenv/config --require babel-core/register scripts/data/export",
     "data:import": "NODE_ENV=development LOG_LEVEL=info node --require dotenv/config --require babel-core/register scripts/data/import",
-    "local:run-docker": "docker-compose -f ./local/full/docker-compose.yml up -d",
+    "local:docker:up": "docker-compose -f ./local/full/docker-compose.yml up -d",
+    "local:docker:down": "docker-compose -f ./local/full/docker-compose.yml down",
+    "local:docker:logs": "docker-compose -f ./local/full/docker-compose.yml logs",
     "local:init": "npm run sync:all && npm run data:import",
     "generate:doc:permissions": "babel-node scripts/permissions-doc",
     "generate:doc:permissions:dev": "nodemon --watch scripts/permissions-doc --watch src --ext js,jsx,hbs --exec babel-node scripts/permissions-doc"