Metadata-Version: 2.1
Name: react-pages
Version: 0.1.7
Summary: A zero-fuss way to create non single page apps with react.
Home-page: https://github.com/pycampers/react-pages
Author: devxpy
Author-email: devxpy@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
Provides-Extra: django integration
Requires-Dist: click
Requires-Dist: crayons
Requires-Dist: halo
Requires-Dist: python-dotenv
Provides-Extra: django integration
Requires-Dist: django; extra == 'django integration'


# React Pages
##### A zero-fuss way to create non single page apps with react.

- Zero Configuration required.
   Mostly thanks to
   [create-react-app](https://github.com/facebook/create-react-app).
- [Custom react scripts](https://github.com/kitze/custom-react-scripts)
   inbuilt.
- Import non-compiled JSX from anywhere
   (create-react-app [doesn't allow this](https://github.com/facebook/create-react-app/issues/834)).
- Ready-to-serve production builds with the proper paths.
    (using `--static-url` option)
- Natively use react in django.
- Go from development to production with ease.
- Caches npm stuff. You'll notice that the command `react-pages project`
    runs much after the 1st time.

## Terminology

#### Project
The project contains the node.js modules necessary
 to use react and the pages you create.

```
└── my_project
    ├── package.json
    ├── package-lock.json
    ├── .env
    ├── .gitignore
    ├── public
    │   ├── favicon.ico
    │   ├── index.html
    │   └── manifest.json
    <pages>
```

#### Page:

A page is a directory containing at least an `index.js` file,
(and other css/js files specific to your application.)

```
└── my_page
    ├── App.css
    ├── App.js
    ├── App.test.js
    ├── index.css
    ├── index.js
    ├── logo.svg
    └── registerServiceWorker.js
```

## Install
[![PyPI version (tag)](https://img.shields.io/badge/pip-0.1.7-blue.svg?longCache=true&style=for-the-badge)](https://pypi.org/project/react-pages/)

`pip install react-pages`

License: MIT License (MIT)<br>
Requires: Python >=3.6

---

If you don't have node, <br>

For bash, use [nvm](https://github.com/creationix/nvm#installation).

For fish shell, you can use `fisher fnm`
([get fisher](https://github.com/fisherman/fisherman)).

Once you have npm/node, react pages will work as expected.

*TODO: make react-pages automatically install node*

## Commands

```sh
# Basic

$ react-pages project my_project # create a "project"

$ cd my_project # don't forget to do this!

$ react-pages page my_page # create a "page"

$ react-pages develop # development

$ react-pages deploy # production

# (open ./my_project/build/my_page/index.html in browser)

# Misc

$ react-pages runserver # django runserver alternative

$ react-pages clear-cache
```

## Django Integration

### Quickstart

__settings.py__
```
INSTALLED_APPS = [
    ...
    'react_pages',
    ...
]

# specify the react-pages project directory
REACT_PAGES_PROJECT_DIR = os.path.join(BASE_DIR, 'my_project')

STATICFILES_DIRS = [
    ...
    os.path.join(REACT_PAGES_PROJECT_DIR, 'build')  # mark the build dir as a static file dir
    ...
]
```

__template.html__
```
{% load react_pages %}
...
{% render_react_page 'my_page' %}
...
```

### Remember to use `react-pages runserver` instead of `manage.py runserver`!
(This was done to remove the manual build step).

That's it!<br>
React Pages will pick-up the "my_page" page from "my_project"
 project and do the necessary work to transpile react JSX.

### Django Context

You can pass django template context varialbes like so -

__views.py__<br>
```python
context['py_var'] = [1, 2, 3]
```

__template.html__<br>
```html
{% render_react_page 'my_page' js_var=py_var %}
```

__App.js__<br>
```js
console.log(js_var);
```

**Note: These must be JSON serializable or JSON serialized.**

### For production, just put `DEBUG=False` in `settings.py` and relax.
**Note: This is not implemented yet.**

## Existing projects

React Pages will automatically patch itsef into any existing project,
that was created using `create-react-app`.

Just run `react-pages project .` from your project directory!

Projects not using `create-react-app` will probably work,
 but no guarantees can be made.

## Issues

- It might not uninstall using pip.

  This is a side-effect of react-page's caching.<br>
  As a temporary fix, Run `react-pages clear-cache`,
  and then `pip uninstall react-pages` will work as expected.

---

<a href="https://www.buymeacoffee.com/u75YezVri" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/black_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>

[🐍🏕️](http://www.pycampers.com/)



