Skip to content

Commit

Permalink
doc: update README for formatting and linting the code (reactplay#858)
Browse files Browse the repository at this point in the history
* doc: update README for formatting and linting the code

* update development environment
  • Loading branch information
Sachin-chaurasiya committed Jan 10, 2023
1 parent 3b2926e commit 2d871be
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .env.development
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
REACT_APP_NHOST_BACKEND_URL=https://rgkjmwftqtbpayoyolwh.nhost.run/
REACT_APP_NHOST_VERSION=v1
REACT_APP_NHOST_ENDPOINT=graphql
REACT_APP_NHOST_ENDPOINT=graphql
DISABLE_ESLINT_PLUGIN=true
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,49 @@ Or
```bash
yarn start
```
**Note**: The `start` script automatically invokes "linters" process. Should you need to run the app without `lint` the use `start:nolint` instead.
However make sure that you run `start` script at least once before committing your code. Code with linter error may not be reviewed.

**Note**: The `start` script automatically invokes "linters" process. Should you need to run the app without `lint` the use `start:nolint` instead.
However make sure that you run `start` script at least once before committing your code. Code with linter error may not be reviewed.

It runs the app in development mode. Open [http:https://localhost:3000](http:https://localhost:3000) to view it in your browser.

The page will reload when you make changes. You may also see any lint errors in the console.

### ✨ Format and lint the code

Use the following command to format and lint the code:

#### Format the code

```bash
npm run format

#OR

yarn run format
```

#### Lint the code

```bash
# to check the linting issue

npm run lint

#OR

yarn run lint


# to fix the linting issue

npm run lint:fix

#OR

yarn run lint:fix
```

### 🧱 Build the App for Production

Use the following command to build the app for production:
Expand Down

0 comments on commit 2d871be

Please sign in to comment.