Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonnydgreen/hello-gen
A set of CLI commands that generates code to make the backend life a dream! Currently WIP - first release coming soon!
https://github.com/jonnydgreen/hello-gen
backend cli graphql oclif typescript
Last synced: 8 days ago
JSON representation
A set of CLI commands that generates code to make the backend life a dream! Currently WIP - first release coming soon!
- Host: GitHub
- URL: https://github.com/jonnydgreen/hello-gen
- Owner: jonnydgreen
- License: mit
- Created: 2021-06-11T12:45:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-26T11:08:04.000Z (over 2 years ago)
- Last Synced: 2023-03-05T22:17:06.368Z (over 1 year ago)
- Topics: backend, cli, graphql, oclif, typescript
- Language: TypeScript
- Homepage: https://github.com/jonnydgreen/hello-gen
- Size: 3.6 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# hello-gen
- [Description](#description)
- [Install](#install)
- [Usage](#usage)
- [Commands](#commands)
- [Contributing](#contributing)
- [License](#license)
## Description
WIP - first release coming soon! :)
HelloGen provides a set of CLI commands to make the backend life a dream so you
can "crack on" with the important things.
## Install
### Manual
Retrieve the hello-gen binary by downloading a
[pre-compiled binary](https://github.com/jonnydgreen/hello-gen/releases) or
compiling it from source.
#### MacOS/Linux
This command assumes that the binary is currently in your downloads folder and
that your `PATH` includes `/usr/local/bin`, but you can customise it if your
locations are different.
```sh
mv ~/Downloads/hello-gen /usr/local/bin/
```
#### Windows
This
[Stack Overflow article](https://stackoverflow.com/questions/1618280/where-can-i-set-path-to-make-exe-on-windows)
contains instructions for setting the PATH on Windows through the user
interface.
### With Deno
```sh
deno install --allow-write --allow-read -f https://raw.githubusercontent.com/jonnydgreen/hello-gen/main/src/hello-gen.ts
```
### With asdf (coming soon)
## Usage
```
$ hello-gen -h
Usage: hello-gen
Version: 0.1.0
Description:
Hello-gen in a generator CLI for all your development needs.
Options:
-h, --help - Show this help.
-V, --version - Show the version number for this program.
Commands:
...
```
# Commands
- [`hello-gen graphql:types`](#hello-gen-graphqltypes)
## `hello-gen graphql:types`
Generates GraphQL Types from an input schema
```
$ hello-gen graphql:types -h
Usage: hello-gen graphql:types
Version: 0.1.0
Description:
Generates GraphQL Types from an input schema
Options:
-h, --help - Show this help.
-i, --input [input] - File path to GraphQL schema. (Default: "schema.graphql")
-o, --output [output] - Output file path to write to. (Default: "types.generated.ts")
```
# Contributing
All PRs are welcome! :)
To get setup, you must install and configure the pre-requisites:
- Install and configure
[Deno](https://deno.land/manual/getting_started/installation).
- Install and configure
[velociraptor](https://velociraptor.run/docs/installation/).
To run tests:
```sh
deno test --lock=lock.json --allow-read --allow-write -A
```
## License
MIT