https://github.com/ef2k/galactico
A cli tool that scaffolds a directory structure according to a predefined template.
https://github.com/ef2k/galactico
Last synced: 4 months ago
JSON representation
A cli tool that scaffolds a directory structure according to a predefined template.
- Host: GitHub
- URL: https://github.com/ef2k/galactico
- Owner: ef2k
- Created: 2013-06-28T20:59:46.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2013-06-30T01:51:11.000Z (almost 13 years ago)
- Last Synced: 2025-10-13T11:12:27.925Z (8 months ago)
- Language: JavaScript
- Size: 117 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Galactico
=========
Quickly scaffold a directory structure from a predefined template.
Status
------
Usable, but lacking polish.
Install
-------
Available through NPM:
```bash
$: npm install galactico
```
Usage
-----
After installing, you'll see a `.galactico` folder in your home directory. This is
where you should drop in your templates, which are javascript files. Have a look at "Creating Templates" below.
Call it using the `gco` or `galactico` commands.
Initializing a template in your current working directory can be done like this:
```bash
$: gco init
```
Creating Templates
------------------
Templates are javascript files placed inside of the `.galactico` folder in your
`home` directory. A basic template looks like this:
```js
// filename: singlepage.js
var singlepage = {
name: 'singlepage',
description: 'A single page website',
directories: ['css', 'js'],
files: ['index.html', 'css/master.css', 'js/main.js']
};
exports.template = singlepage;
```
Drop the file in `$HOME/.galactico`.
Using it via `$: gco init singlepage` will result in a directory structure like this:
```text
- index.html
- css /
- master.css
- js /
- main.js
```
TODO
----
* List templates using `$: gco list`.
* Generate template files using `$: gco template `.