fix: update README.md and npx command

Author: gobeam

README.md

@@ -1,8 +1,13 @@
+<div align="center">
+<img src="./app/assets/images/logo/short-logo.svg" alt="Truthy Logo">
+</div><br>
 <h1 align="center">
   Truthy CMS (ReactJS Starter)
 </h1>
 
-<div align="center"> This repository is frontend part of Truthy CMS written in ReactJS & Redux-Saga. [Ant design](https://ant.design/) is used as a UI library. This project includes User Management, Role Management, Permission Management, Email Module, Account Settings, OTP, RBAC support, Localization, and many more. </div>
+<div align="center"> This repository is frontend part of Truthy CMS written in ReactJS & Redux-Saga. For Backend API please visit https://github.com/gobeam/truthy. Ant design (https://ant.design/) is used as a UI library. This project includes User Management, Role Management, Permission Management, Email Module, Account Settings, OTP, RBAC support, Localization, and many more. Hope you like it.<br>
+If you love it don't forget to share your experience. If you want to contribute to the Truthy CMS in any way like API, Frontend, Design, Logo you're more than welcome to do so. Our plan is to make this no. 1 CMS maintained by opensource community.
+ </div>
 
 <br>
 <div align="center">
@@ -33,27 +38,27 @@ https://nodejs.org/en/
 
 In the project directory, you can run:
 
-### `npm start`
+### `yarn start`
 
 Runs the app in the development mode.<br>
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
 Hot reload is supported on the development environment page will reload if you make edits.<br>
 You will also see any lint errors in the console.
 
-### `npm run build`
+### `yarn build`
 
 Builds the app for production to the `build` folder.<br>
 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.<br>
 Your app is ready to be deployed!
 
-### `npm run lint`
+### `yarn lint`
 
 Lints all the files inside `./src` and shows the result without fixing.
 
-### `lint:js:fix`
+### `yarn lint:js:fix`
 
 Lints all the files inside `./src`.
 
@@ -116,11 +121,11 @@ app
 │   └── helpers                             * Common Helper functions.
 │   └── hooks                               * Feature to use state and other React functionalities without writing class.
 │   └── i18n                                * Translation files.
-│   └── reducers                            * Pure function that takes an action and the previous state of the application and returns the new state.
+│   └── reducers                            * Pure function that takes an action and the previous state of the application and returns the 
 │   └── routes                              * Routes list.
 │   └── scss                                * Scss files for the project.
 │   └── services                            * Common services file.
-│   └── store                               * The Redux action types in action-type.js, reducers, selectors, and main store in the sub-folders.
+│   └── store                               * The Redux action types in action-type.js, reducers, selectors, and main store in the 
 │   └── utils                               * Common utils.
 │   └── app.js                              * Main app component.
 │   └── global-style.js                     * Global styles.
@@ -139,6 +144,8 @@ app
 ├── .env                                    * Environment variables (env.production, env.local, env.uat, etc).
 ├── .eslintrc.json                          * ESLint configuration and rules.
 ├── .prettierrc                             * Formatting Prettier options.
+├── Dockerfile                              * Docker file for prod environment.
+├── Dockerfile.dev                          * Docker file for dev environment.
 ```
 
 ## Contributing

bin/cli.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+const { execSync } = require('child_process');
+
+const RESET = '\x1b[0m';
+const GREEN = '\x1b[32m';
+const YELLOW = '\x1b[33m';
+const WHITE = '\x1b[37m';
+const RED = '\x1b[31m';
+const CYAN = '\x1b[36m';
+const MAGENTA = '\x1b[35m';
+
+const getColoredText = (text, color) => {
+  if (color == null) {
+    // eslint-disable-next-line no-param-reassign
+    color = WHITE;
+  }
+  return color + text + RESET;
+};
+
+const runCommand = (command) => {
+  try {
+    execSync(`${command}`, { stdio: 'inherit' });
+  } catch (e) {
+    console.error(
+      getColoredText(`Failed to execute ${command}. Error: ${e}`, RED),
+    );
+    return false;
+  }
+  return true;
+};
+
+const repoName = process.argv[2];
+const gitCheckoutCommand = `git clone --depth 1 https://github.com/gobeam/truthy-react-frontend ${repoName}`;
+const installDepsCommand = `cd ${repoName} && yarn install`;
+
+console.log(
+  getColoredText(`Cloning the repository with name ${repoName}`, CYAN),
+);
+const checkedOut = runCommand(gitCheckoutCommand);
+if (!checkedOut) process.exit(-1);
+
+console.log(getColoredText(`Installing dependencies for ${repoName}`, YELLOW));
+const installedDeps = runCommand(installDepsCommand);
+if (!installedDeps) process.exit(-1);
+
+console.log(
+  getColoredText(
+    'Congratulations! You are ready. Follow the following commands to start',
+    MAGENTA,
+  ),
+);
+console.log(getColoredText(`cd ${repoName} && yarn start`, GREEN));

package.json

@@ -1,6 +1,6 @@
 {
   "name": "truthy-react-cms",
-  "description": "",
+  "description": "Truthy CMS starter template for React",
   "version": "0.1.0",
   "license": "MIT",
   "author": "gobeam <[email protected]>",
@@ -18,9 +18,12 @@
     "react dashboard",
     "react admin template",
     "free react",
-    "react ui library"
+    "react ui library",
+    "antd",
+    "react-antd",
+    "opensource cms"
   ],
-  "private": true,
+  "bin": "./bin/cli.js",
   "scripts": {
     "prebuild": "npm run build:clean",
     "build": "cross-env NODE_ENV=production webpack --config internals/webpack/webpack.prod.babel.js --color --progress",