https://github.com/timvw/generator-scala
https://github.com/timvw/generator-scala
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/timvw/generator-scala
- Owner: timvw
- Created: 2015-08-13T14:11:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T11:45:31.000Z (over 1 year ago)
- Last Synced: 2024-10-02T22:30:49.065Z (8 months ago)
- Language: JavaScript
- Size: 76.2 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Scala Yeoman Generator
The aim of the project is to provide an easy way to scaffold scala projects outside an IDE such as IntelliJ or Eclipse.
## Getting started
### What is Yeoman?
Trick question. It's not a thing. It's this guy:
Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
```bash
npm install -g yo
```
### Yeoman Generators
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
To install generator-scala from npm, run:
```bash
npm install -g generator-scala
```
Finally, initiate the generator:
```bash
yo scala
```
Currently we support 3 subgenerators (maven, sbt and gradle). Each of them accepts the appliation name (default: current directory name) and scala version (default: 2.12.1)
In case you want to go fast, you can provide values for the requested parameters:
```bash
yo scala sbt foo 2.11.8
```
### Maintainer(s)
- [@timvw](https://github.com/timvw)