generator-omaha

KO | EN

gitlite — search

#hacktoberfest #go #golang #android #machine-learning #rust #deep-learning #macos #nodejs #java #awesome #security #mcp #openai

generator-omaha

(★ 12)

Yeoman generator designed to help you craft sustainable code for the modern web

generator-omaha 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> A [Yeoman](http://yeoman.io) generator for the modern front-end artisan designed to help you craft sustainable code for the web.

Quick Start
-----------
✔ Install [Yeoman](http://yeoman.io/) CLI tool, [Grunt](http://gruntjs.com/) CLI tool,  and [generator-omaha node module](https://www.npmjs.com/package/generator-omaha) globally
```bash
npm install --global yo grunt-cli generator-omaha
```
✔ Create an empty directory and cd into it
```bash
mkdir my-project && cd my-project
```
✔ Run omaha generator
```bash
yo omaha
```
✔ Make some choices
<div align="center">
    <img width="100%" type="image/svg+xml" src="https://jhwohlgemuth.github.io/images/choices-railroad-diagram.svg?v=1.7" alt="Generator Choices Rail Diagram" title="Generator Choices Rail Diagram"/>
</div>
</br>
✔ Start creating your app!
</br>

[![omaha generator quick start asciicast](https://asciinema.org/a/gWenj2iSZu92MKunVzOSH5iTy.png)](https://asciinema.org/a/gWenj2iSZu92MKunVzOSH5iTy)

Patterns are Paramount
----------------------

`generator-omaha`strives to enable developers of various skill and experience to more easily implement patterns and architectures with minimal time and effort. Specifically, `generator-omaha` enables the following patterns and capabilities:

- Composite architecture using Marionette.js, "The Backbone Framework"
- [Event driven interactions using Backbone.Radio](https://github.com/omahajs/generator-omaha/tree/master/generators/webapp/templates/plugins#radiologgingjs)
- View templating with Handlebars (or Lodash) and template pre-compilation
- [Predictable state management with Redux](https://github.com/omahajs/generator-omaha/tree/master/generators/webapp/templates/plugins#reduxstatejs)
- Workflow with support for linting, optimization, testing, bundling, documentation and transpilation.
- End-to-end (E2E) browser testing with [Nightwatch.js](http://nightwatchjs.org/)

The default sub-generator may be for a web app, but `generator-omaha` also has [sub-generators](https://github.com/omahajs/generator-omaha/blob/master/GENERATORS.md) for crafting:

- [servers](https://github.com/omahajs/generator-omaha/blob/master/GENERATORS.md#server) built on express with security baked in (using lusca and helmet)
- [plugins](https://github.com/omahajs/generator-omaha/blob/master/GENERATORS.md#plugin) to support a modular architecture
- [projects](https://github.com/omahajs/generator-omaha/blob/master/GENERATORS.md#project) with pre-configured modern workflows
- [native desktop applications](https://github.com/omahajs/generator-omaha/blob/master/GENERATORS.md#native) built on Electron --> *quickly turn your web app into a desktop app*!

Typical Workflows
-----------------
> After scaffolding a new project with `yo omaha` ...

- Serve live-reload enabled app with companion RESTful API using `npm start`, then...
  - :sparkles: lint your code in real-time with a second terminal running `npm run lint:watch`
  - :100: run tests and calculate code coverage in real-time with `npm run test:watch`
  - :lipstick: see your style updates and code changes in the browser with a second terminal running `grunt styling`
- Run tests with `npm test`
- One-time lint with `npm run lint`
- Run tests and lint code as a watch task in one terminal with: `npm run dev` (*linux only*)
- Demo your bundled project in a browser with `npm run demo`
- View reports, documentation and styleguide:
  - code coverage: `grunt cover open:coverage`
  - JSDocs documentation: `grunt docs open:docs`
  - Living styleguide: `grunt docs open:styleguide`
- [Review the code](/generators/webapp/templates/tasks) to see all the available tasks

> View the [lint rules that make your code more secure](https://github.com/omahajs/eslint-config-omaha-prime-grade/blob/master/RULES_FOR_SECURITY.md)

Command Line Options
--------------------
> Beyond `yo omaha --help`

- Scaffold a web app after making some choices via prompts (options are not honored without the use of `--defaults`)

```bash
yo omaha
```

- Scaffold a web app "auto-magically" with defaults and no user input

```bash
yo omaha --defaults
```

- Use "silent" webapp defaults, skip support for everything, and select custom source directory

```bash
yo omaha --defaults --slim --src src
```

- Use "silent" web app defaults with [Webpack](https://webpack.js.org/)

```bash
yo omaha --defaults --use-webpack
```

- Use "silent" web app defaults with [Browserify](http://browserify.org/) and [Jest](https://facebook.github.io/jest/)

```bash
yo omaha --defaults --use-browserify --use-jest
```

- Use "silent" web app defaults with custom modifications

```bash
yo omaha --defaults --template-technology lodash --skip-coveralls
```

**Available options**
> Default in **bold**

- `--defaults`: scaffold app with no user input using defaults
- `--slim`: use with `--defaults` to perform "slim" install (all options skipped)
- `--src`: use with `--defaults` to select custom source directory for app and assets files
- `--amd`: use AMD module format (with r.js as script bundler)
- `--use-browserify`: use Browserify as script bundler (auto selects CommonJS module format)
- `--use-jest`: use Facebook's Jest instead of mocha (auto selects CommonJS module format)
- `--use-webpack`: use Webpack as script bundler (auto selects CommonJS module format and Jest test framework)
- `--use-rust`: Add folder structure, sample file, and build scripts for WebAssembly development using Rust (`rustc` and `wasm-gc` required)
- `--skip-imagemin`: use with `--defaults`
- `--css-preprocessor`: **`less`** | `sass` | `none`
- `--template-technology`: **`handlebars`** | `lodash`

**But wait, there's more!** Read about [all the available generators!](GENERATORS.md)

Alternatives
------------
- See wiki page: [Tools for Creating Web Apps](https://github.com/omahajs/omahajs.github.io/wiki/Tools-for-Creating-Web-Apps)

Credits
-------
- [Yeoman](http://yeoman.io/) (d'uh)
- [railroad-diagrams](https://github.com/tabatkins/railroad-diagrams)
- [electron-forge](https://github.com/electron-userland/electron-forge)
- All the awesome open source projects that make *this project* possible

A Note on Semantic Versioning
-----------------------------
> This project strives to follow the principles of semantic versioning ([semver](http://semver.org/)). However, it seems unreasonable to release major versions for changes to the generated output of `generator-omaha` that are not backwards compatible with the generated output of previous versions. In general, this project will release major versions when the generator API is not backwards compatible ***or*** when the generated outputs undergo substantial changes. In the case of the latter, *a major version increment would serve more as a signifier of significant change* (not necessarily changes that are not backwards compatible). I am perhaps making this more complicated than necessary; however, I want to avoid superficial "churn" while still maintaining a standardized process for development and enhancement.

License
-------
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fomahajs%2Fgenerator-omaha.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fomahajs%2Fgenerator-omaha?ref=badge_large)

generator-omaha

generator-omaha 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

generator-omaha

generator-omaha 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README