This repository has been archived by the owner on Aug 29, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from thiagodesouza/master
chore(v4): allow npm deploy pre-releases
- Loading branch information
Showing
8 changed files
with
98 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 - Neutron JS | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
## 🚀 Overview | ||
|
||
Neutron is a CLI developed to help developers create new react projects with [Redux](https://redux.js.org/) + [Redux Saga](https://redux-saga.js.org/) and offers well-structured code standardization. | ||
|
||
#### Templates and Scaffolding | ||
|
||
- [x] React JS | ||
- [x] React Native | ||
|
||
## 👨🏽💻 Quick Start | ||
|
||
To install Neutron JS, execute into your terminal: | ||
|
||
```shell | ||
# yarn | ||
$ yarn global add @neutronjs/cli | ||
|
||
# npm | ||
$ npm i @neutronjs/cli -g | ||
``` | ||
|
||
Command list: | ||
|
||
```shell | ||
Starts With: | ||
neutron create Create new project with React | ||
|
||
Commands: | ||
neutron add:component Add new component files | ||
neutron add:duck Add new duck file | ||
neutron add:page Add new page files | ||
neutron add:saga Add new saga and duck files | ||
|
||
Utils: | ||
neutron -h Show help information | ||
neutron -v Output the version number | ||
``` | ||
|
||
## 🚘 What's under the hood? | ||
|
||
- ⭐ [exec-sh](https://github.com/tsertkov/exec-sh) - wrapper for `child_process.spawn` with some improvements; | ||
- ⭐ [gluegun](https://github.com/infinitered/gluegun) - toolkit for building node-based command-line interfaces; | ||
- ⭐ [hyperquest](https://github.com/substack/hyperquest) - treat http requests as a streaming transport; | ||
- ⭐ [tar-pack](https://github.com/ForbesLindesay/tar-pack) - package and un-package modules of some sort (in tar/gz bundles); | ||
|
||
|
||
## 📃 Contributing | ||
|
||
Thanks for your interest on our project. Take a moment to read our guidelines: | ||
|
||
- [Contributing](https://www.neutronjs.com/docs/community/contributing) | ||
- [Code of Conduct](https://www.neutronjs.com/docs/community/code-of-conduct) | ||
|
||
## 📮 Contact | ||
|
||
We have a few channels for contact: | ||
|
||
- Email: [[email protected]](mailto:[email protected]) | ||
- [GitHub Issues](https://github.com/neutronjs/neutron/issues) | ||
|
||
<hr/> | ||
|
||
## 📃 License | ||
|
||
MIT © [Neutron JS](http://www.neutronjs.com/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters