Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dolphjs/dolph-cli
Efficient and Fast CLI tool for generating, linking and managing dolphjs components, registering files and running dolphjs.
https://github.com/dolphjs/dolph-cli
Last synced: about 5 hours ago
JSON representation
Efficient and Fast CLI tool for generating, linking and managing dolphjs components, registering files and running dolphjs.
- Host: GitHub
- URL: https://github.com/dolphjs/dolph-cli
- Owner: dolphjs
- License: mit
- Created: 2023-11-17T22:40:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-12T17:27:13.000Z (2 months ago)
- Last Synced: 2024-11-13T17:54:45.934Z (6 days ago)
- Language: TypeScript
- Homepage:
- Size: 215 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# dolphjs cli
The dolphjs-cli is a tool used for efficient initialization and management of a dolphjs project.
## Commands
**new**: the alias for this command is `n`. This command is used to initialize / start a new project. It takes the name of the project as an option
```bash
dolph-cli new
```
or use `' . '` in place of `` to initialize the project in current directory.
After this, you'll be prompted with few questions which would be used to configure your dolphjs project. Navigate to the project folder and run
```bash
yarn
```
to install all packages .
**generate**: the alias for this command is `g` and is used to generate files and folders with setup code for :
- controllers
- services
- models
- routes
It is recommended to make use of the `generate` command when one wants to create these files because it generates code the dolphjs way. In a scenario when you want to create files for all of the above, let's say you want to write code for user logic and functionalities, use the `-a` flag, as in:
```bash
dolph-cli g -a user
```
the command above creates a service, controller, model and routes file for `user` and set's you up for writing business logic. Alternatively, you might want to create one of the files (controllers, models, services, routes) so you make use of their independent flags:
- controller:
```bash
dolph-cli g -c
```
- service:
```bash
dolph-cli g -s
```
- model:
```bash
dolph-cli g -m
```
- route:
```bash
dolph-cli g -r
```
## Credit
dolphjs-cli is inspired by methane-cli [https://github.com/adedoyin-Emmanuel/methane-cli]