Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cmorten/opine-cli
Opine's application generator
https://github.com/cmorten/opine-cli
deno deno-doc deno-module denojs denoland express expressjs opine
Last synced: 25 days ago
JSON representation
Opine's application generator
- Host: GitHub
- URL: https://github.com/cmorten/opine-cli
- Owner: cmorten
- License: mit
- Created: 2020-12-22T11:44:06.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T09:43:01.000Z (10 months ago)
- Last Synced: 2024-09-16T14:48:02.144Z (2 months ago)
- Topics: deno, deno-doc, deno-module, denojs, denoland, express, expressjs, opine
- Language: TypeScript
- Homepage:
- Size: 51.2 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Opine CLI
Opine's application generator.
---
## Table of Contents
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Command Line Options](#command-line-options)
- [Contributing](#contributing)
- [License](#license)
## Installation
```console
$ deno install -f -q --allow-read --allow-write --allow-net --unstable https://deno.land/x/[email protected]/opine-cli.ts
```
And follow any suggestions to update your `PATH` environment variable.
## Quick Start
The quickest way to get started with Opine is to utilize the Opine CLI to generate an application as shown below:
Create the app:
```console
$ opine-cli --view=ejs hello-deno && cd hello-deno
```
Start your Opine app at `http://localhost:3000/`:
```console
$ deno run --allow-net --allow-read --allow-env mod.ts
```
## Command Line Options
This CLI can be further configured with the following command line flags:
```txt
-h, --help - Show this help.
-V, --version - Show the version number for this program.
-v, --view - add view support (ejs|eta)
-g, --git - add .gitignore
-f, --force - force on non-empty directory
```
## Contributing
[Contributing guide](https://github.com/cmorten/opine-cli/blob/main/.github/CONTRIBUTING.md)
---
## License
There are several third party modules that have been ported into this module. Each third party module has maintained it's license and copyrights. The only exception is for Express Generator, from which this entire module has been ported, whose license and copyrights are available at [EXPRESS_GENERATOR_LICENSE](./EXPRESS_GENERATOR_LICENSE.md) in the root of this repository, and cover all files within the [source](./src) directory which not been explicitly licensed otherwise.
All modules adapted into this module are licensed under the MIT License.
Opine CLI is licensed under the [MIT License](./LICENSE.md).
Icon designed and created by [Hannah Morten](https://www.linkedin.com/in/hannah-morten-b1218017a/).