https://github.com/bigyanse/petor
A project generator based on Node.js.
https://github.com/bigyanse/petor
javascript nodejs project-generator typescript
Last synced: about 1 month ago
JSON representation
A project generator based on Node.js.
- Host: GitHub
- URL: https://github.com/bigyanse/petor
- Owner: bigyanse
- License: mit
- Created: 2023-06-25T14:57:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-13T14:06:55.000Z (almost 3 years ago)
- Last Synced: 2025-01-31T17:42:55.730Z (over 1 year ago)
- Topics: javascript, nodejs, project-generator, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/petor
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# petor
petor is a project generator that generates a custom project built beforehand.
## Installation
- npm: `npm install -g petor`
- yarn: `yarn global add petor`
Note: You may need to add npm or yarn global bin path in your `PATH` environment variable.
## Usage
petor generates a project from the templates directory.
```bash
petor --generate backend
```
By default, project is generated with the name same as the template name. You can generate the project with custom name as,
```bash
petor --generate backend restapi
```
You can check the existing templates as,
```bash
petor --list
```
You can add your own templates to the path indicated by the,
```bash
petor --get-template-dir
```
## Build
- `git clone https://github.com/bigyanse/petor.git`
- `cd petor`
- `yarn install` or `npm install`
- `yarn build` or `npm run build`
- Then you can run the program with `node .` or `node ./dist/src/cli.js`