Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joojscript/phoenix_reactify
Phoenix Reactify is an amazing mix task capable of adding a simple React implementation to your fresh phoenix projects.
https://github.com/joojscript/phoenix_reactify
elixir javascript phoenix react
Last synced: about 2 months ago
JSON representation
Phoenix Reactify is an amazing mix task capable of adding a simple React implementation to your fresh phoenix projects.
- Host: GitHub
- URL: https://github.com/joojscript/phoenix_reactify
- Owner: joojscript
- Created: 2021-06-22T22:47:48.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-06T19:49:50.000Z (about 3 years ago)
- Last Synced: 2024-09-17T08:58:12.455Z (3 months ago)
- Topics: elixir, javascript, phoenix, react
- Language: Elixir
- Homepage: https://hex.pm/packages/phoenix_reactify
- Size: 1.25 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Phoenix Reactify
**Phoenix Reactify** is an amazing **mix task** capable of adding a simple React implementation to your fresh **phoenix projects**.
⚠ **WARNING**: Currently, because of some webpack version related issues, this library its only compatible with **Phoenix 1.5.9+** or any other that have webpack ~4.5 as peer-dependency.
### How does PhoenixReactify works?
It uses the amazing [remount](https://github.com/rstacruz/remount) library to make your entire SPA App into a html tag, so that you can use into your phoenix application's templates
## Installation
My first idea was to release it as a mix archive, so that you could use it in any project, once installed, just like `mix phx.new` command. But since mix archives cannot bundle dependencies (and this project has), I had to release it in two different ways:
- As a hex.pm package, that you can install like this, pasting this code into your **mix.exs** file:
```elixir
def deps do
[
# other dependencies
{:phoenix_reactify, "~> 0.0.5"}
]
end
```
Feel free to remove it from the dependencies once you've set up your project 😄
- Or, at every release I put a binary-compiled file altogether, you can download it [directly from the releases page](https://github.com/joojscript/phoenix_reactify/releases), and then, run it inside your fresh phoenix project.
```bash
$ ./phoenix_reactify
```
## Usage
At this moment, Phoenix Reactify supports these options:
- -p, --project: Specifies the React project name (Default to SPA).
- -v, --verbose: Ensures verbose output.
- -t, --typescript: Enables Typescript support.
- --npm-force-install: Uses the **force** keyword on npm installations.
```sh
mix phx.reactify --typescript --project --verbose
```
By default, the library already puts the first entrypoint tag to the default elixir first page template (lib/\\_web/templates/page/index.html.eex). But you can always create new tags and even multiple SPAs! If you want this kind of behaviour, please refer to [Advanced Usage](https://github.com/joojscript/phoenix_reactify/blob/master/ADVANCED_USAGE.md)
With your default first tag set, just fire up localhost:4000 (default phoenix server port), and you should see that, if everything gone well:
⚠ **WARNING**: be careful with route conflicts between the applications
## ToDo
- 🕐 Automatic route mapping (probably via macros or something like that).
- 🕐 Bundle dependencies together to distribute as mix archive.
- ✅ Typescript support (deppends on babel).
- ✅ Auto-Inject first generated tag (not trully necessary, but I think it would be more user-friendly).
## License
[MIT](https://choosealicense.com/licenses/mit/)