Skip to content

Commit

Permalink
generator: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pablopalacios committed May 12, 2021
1 parent 5aeabb2 commit 60b9f87
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions packages/generator-fluxible/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,26 @@ Finally, initiate the generator:
yo fluxible
```

During development, execute `npm run dev` to initiate webpack-dev-server
(with react-hot-loader support) and your application's server using nodemon.
Browse to `http://localhost:3000` to see a very simple Fluxible site with
During development, execute `npm run dev` to initiate webpack-dev-server
(with react-hot-loader support) and your application's server using nodemon.
Browse to `http://localhost:3000` to see a very simple Fluxible site with
server-side rendering and client-side navigation. When you change files,
the client will be hot-reloaded (with the exception of stores) and your
application server will restart so that you can see the server-side changes
on the next refresh.
the server will be reloaded and the bundle will be rebuilt.

For other environments, make sure your application is built using
For other environments, make sure your application is built using
`npm run build` and then run `npm start`.

## Debugging

Fluxible uses [debug](https://www.npmjs.com/package/debug) to expose debugging
information on the server and client.
Fluxible uses [debug](https://www.npmjs.com/package/debug) to expose debugging
information on the server and client.

### Server

Start the application with the `DEBUG` environment variable: `DEBUG=* grunt`.

### Client

`fluxibleDebug` is exposed to the `window` object to manage debugging. You can
enable it via the browser console: `fluxibleDebug.enable('*');` then refresh
`fluxibleDebug` is exposed to the `window` object to manage debugging. You can
enable it via the browser console: `fluxibleDebug.enable('*');` then refresh
the page. To disable, type the following: `fluxibleDebug.disable();`.

0 comments on commit 60b9f87

Please sign in to comment.