2.5.4 โ€ข Published 3 years ago

neu2 v2.5.4

Weekly downloads
9
License
GPL-3.0
Repository
github
Last release
3 years ago

About The Project

What's that ?

This is Neu2, my rework of neu-cli, to allow devs to create a NeutralinoJS app faster and easier.

Why ?

Because I had a bad experience with neu-cli, and I had nothing to do. So I threw myself into this little challenge, hoping it would make some people happy!

Built With

Getting Started

Prerequisites

This project was coded with NodeJS 14 on Linux (Manjaro). It hasn't been tested yet on Windows and MacOS (but that shouldn't be a problem).

It has been somewhat tested on NodeJS 12, the older versions not being used much anymore, I don't think it will be a problem either. However, I'm waiting for your feedback!

Installation

  1. Download the project with...
    • ... NPM:
      npm install -g neu2
    • ... Yarn:
      yarn global add neu2
    • ... Git:
      git clone https://github.com/TomaruDev/neu2.git
  2. If Git is used, you have to link the project with...
    • ... NPM:
      			 npm link
    • ... Yarn:
      			 yarn link

Usage

For the moment, the documentation in the README.md is not yet available. It will be coming soon!

In the meantime, you can still use the command line doc. Just type :

neu2 help

once Neu2 is installed on your computer.

ToDo List

  • Finish the README
  • Add a Plugin System
  • Fix bugs ๐Ÿž

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE.md for more information.

Contact

TomaruDev - @MrTomaru - contact@tomaru.dev

Project Link: https://github.com/TomaruDev/neu2

Acknowledgements

Thanks to the devs of NeutralinosJS for creating... NeutralinoJS !