Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igeligel/plop-scripts
:tada: Scripts, written in JavaScript, which will create several files for different type of frameworks or applications.
https://github.com/igeligel/plop-scripts
generator java npm plop readme
Last synced: 5 days ago
JSON representation
:tada: Scripts, written in JavaScript, which will create several files for different type of frameworks or applications.
- Host: GitHub
- URL: https://github.com/igeligel/plop-scripts
- Owner: igeligel
- License: mit
- Created: 2016-10-19T18:31:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-21T21:46:58.000Z (almost 8 years ago)
- Last Synced: 2024-11-19T09:53:34.590Z (2 months ago)
- Topics: generator, java, npm, plop, readme
- Language: HTML
- Homepage:
- Size: 54.7 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# plop-scripts by igeligel
Scripts, written in JavaScript, which will create several files for:
- [Java EE applications](/templates/javaee)
## Dependencies
npm:
- [plop](https://www.npmjs.com/package/plop)
I have not included plop as npm package here because you should install it globally to access other files also. For more instructions check out the [Installation](##Installation).
## Installation
You need to have plop installed. You can easily install this by npm. The easiest way to get npm is to install [node.js](https://nodejs.org/en/download/) on your machine. Otherwise you can also install a [standalone version of npm](https://github.com/npm/npm/releases).
After you have npm ready on your machine, make sure you have access to git and clone this repository. You can also download it via GitHub.
After downloading/cloning, open a new console and change the directory to the folder of the repository. It should look like this:
If you can see the *package.json* file you have installed all requirements for this project.
After this you need to install [plop](https://www.npmjs.com/package/plop). To install it globally open your command line/console and type:
```
$ npm install -g plop
```
## How to use
Change the directory to the project where you can see the *package.json* file.
After you have done all steps of the [Installation](##Installation) you can type:
```
$ npm run plop
```
After this you come up with this menu:
Now you can navigate with your arrow keys and decide the different options for creating templates.
## License
[MIT License](LICENSE)
## How to grab documentation
There is no real documentation right now because this is a simple side project. Lookup the [documentation folder](/documentation) for more resources.
## Contributing
1. Clone the repository
2. Make a new branch for your feature
3. Make the changes you want and commit
4. Make pull request to origin master
### Commits
For commits i am using [this style](https://github.com/igeligel/contributing-template/blob/master/commits.md). You should also use this style when you are creating pull requests.
## Authors
- [igeligel](https://github.com/igeligel)
## Contact information
[ Steam](http://steamcommunity.com/profiles/76561198028630048/)
[ Twitter](https://twitter.com/kevinpeters_)
## History
| Date | Version | Description |
| ------------- | ------------- | -------------------- |
| 10/20/16 | -/- | Start of the project |