https://github.com/vineyardbovines/skeletor
generate a bare bones project with the necessary files 💀
https://github.com/vineyardbovines/skeletor
automation-script build-tool project-generator project-initialization project-starter
Last synced: 3 months ago
JSON representation
generate a bare bones project with the necessary files 💀
- Host: GitHub
- URL: https://github.com/vineyardbovines/skeletor
- Owner: vineyardbovines
- License: mit
- Created: 2019-07-31T19:24:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-07T20:17:37.000Z (over 5 years ago)
- Last Synced: 2024-11-17T21:29:32.259Z (6 months ago)
- Topics: automation-script, build-tool, project-generator, project-initialization, project-starter
- Language: Shell
- Homepage:
- Size: 587 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Init a project with the necessary ~~evils~~ files super fast.
## Getting Started
### Requirements
- jq
```bash
brew install jq
```
### Installation
```bash
$ git clone https://github.com/gretzky/skeletor && cd skeletor
$ make install
```
by default, it installs to `/usr/local`. you can change the prefix if necessary.
```bash
$ make PREFIX=$WHATEVER install
```
you can uninstall with `make uninstall`
run `skeletor -h` for a help menu.
### Usage
```bash
$ skeletor [-l ] [-L ] [project-name]
```
By default, skeletor will build a directory with a few standard files: editorconfig, gitignore, LICENSE, and a README.
The license defaults to MIT, you can pass the `-L` flag with an argument to get a different license. Supported licenses: AGPL, Apache2.0, BSD2, BSD, GPL2.0, GPL3.0, MIT, MPL2.0, and Unlicense.
The gitignore utilizes the [gitignore.io](https://gitignore.io) api and will automatically build a config for your machine that covers your OS, your editor (if a default one is set or an editor is detected), and the language you chose.
### Language Support
Some languages will also initialize after your project is built.
**JS/TS**
Runs `npm` or `yarn` init, and `tsc --init` if you pass typescript.
**Python**
Adds a `requirements.txt` and sets up a virtualenv if virtualenv is globally installed.
**Rust**
Runs `cargo init`