Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sheppard authored Sep 29, 2020
1 parent dac0fe2 commit 4fd1764
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This is the recommended Django project template for projects utilizing the [wq framework]. It uses [wq.app] for the front end and [wq.db] as the backend component. This template is meant to be used together with [wq.start]. See wq's [Getting Started] docs for more information.

This template provides two alternatives for managing JavaScript dependencies ([@wq/app]/[wq.app]). The alternatives can be selected by passing the `--with-npm` or `--without-npm` arguments to the `wq start` command.
This template provides two alternatives for managing JavaScript dependencies ([@wq/app] & [wq.app]). The alternatives can be selected by passing the `--with-npm` or `--without-npm` arguments to the `wq start` command.

* `--with-npm`: `wq start` will generate an app/ folder based on the [@wq Create React App template][@wq/cra-template] and install [@wq/app] and [@wq/material] from NPM.
* `--without-npm`: `wq start` will generate an app/ folder containing a minimal web-ready JavaScript configuration that can be merged with [wq.app]'s assets by running `./manage.py collectstatic`. This leverages a new pre-compiled and minified ESM module, [**wq.js**](https://npmjs.com/package/wq), introduced in wq.app 1.3.
Expand All @@ -14,7 +14,7 @@ This template provides two alternatives for managing JavaScript dependencies ([@

This project template is also useful as an example of how to build a web app with [React] and a [Django REST Framework] backend. It differs from the default Django and Create React App templates in a few key ways:

* Key front end files are kept in the `app/` folder, making it easier to customize the gerated [installable PWA], and (optionally) to compile the front end with React Native or Expo for distribution on the app stores.
* Key front end files are kept in the `app/` folder, making it easier to customize the generated [installable PWA], and (optionally) to compile the front end with React Native or Expo for distribution on the app stores.
* Because of this separation, the root of the Django project is in `db/` rather than at the top level of the project.
* The root `ReactDOM.render()` call and Redux initialization are handled automatically by [@wq/react] and [@wq/store]. It is not necessary to explicitly define any React components, except to override the default [@wq/material] UI.
* A default Apache2 WSGI configuration is included in `conf/`
Expand All @@ -26,10 +26,10 @@ This project template is also useful as an example of how to build a web app wit
[Getting Started]: https://wq.io/docs/setup

[@wq/app]: https://wq.io/docs/app-js
[@wq/cra-template]: https://github.com/wq/wq.start/tree/packages/cra-template
[@wq/material]: https://github.com/wq/wq.app/tree/packages/material
[@wq/react]: https://github.com/wq/wq.app/tree/packages/react
[@wq/store]: https://github.com/wq/wq.app/tree/packages/store
[@wq/cra-template]: https://github.com/wq/wq.start/tree/master/packages/cra-template
[@wq/material]: https://github.com/wq/wq.app/tree/master/packages/material
[@wq/react]: https://github.com/wq/wq.app/tree/master/packages/react
[@wq/store]: https://github.com/wq/wq.app/tree/master/packages/store

[React]: https://reactjs.org/
[Django REST Framework]: http://www.django-rest-framework.org
Expand Down

0 comments on commit 4fd1764

Please sign in to comment.