https://github.com/andismith/graaff
Static Sites Assembled
https://github.com/andismith/graaff
Last synced: 2 months ago
JSON representation
Static Sites Assembled
- Host: GitHub
- URL: https://github.com/andismith/graaff
- Owner: andismith
- License: mit
- Created: 2014-09-16T23:27:31.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-03-12T02:28:16.000Z (over 10 years ago)
- Last Synced: 2025-02-07T18:53:30.720Z (4 months ago)
- Language: JavaScript
- Homepage: http://www.andismith.com/graaff/
- Size: 469 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# Graaff
## Your Static Site - Assembled
**.gitignore**
Thanks for checking out our project! It's not *quite* ready to use yet, so please hit the star button and come back shortly!
## Getting Started
Detailed information about getting started can be found on the Graaff website (coming soon).
To get started quickly:
* Open Terminal (or Command Prompt) and navigate to your usual workspace directory
* Ensure you have [NodeJS](http://nodejs.org/) installed (using v0.10.*)
* Make a directory for your project with `mkdir projectname`
* Change directory in the project with `cd projectname`
* Clone the Git repo with `git clone https://github.com/andismith/graaff .`
* Install our dependencies with `npm install`
* If you don't have Grunt CLI, you'll need to install it with `npm install -g grunt-cli`
* Make a copy of the default content folder to get you started `cp -r _content content`
* Run Grunt with the command `grunt`
* By default, Graaff will be available at [localhost:3000](http://localhost:3000/)
Graaff's files are split in to three main folders, found in the `src` folder:
* `content` - This is where your pages and posts live. Each folder in this directory is a folder on your site. Each file is a page. Files are `index.hbs` files, and can be opened in any code editor.
* `logic` - This is the engine behind Graaff. There's not a lot in here, as we're using [Grunt](http://gruntjs.com/) and [Assemble](http://assemble.io) to do most of the hard work.
* `themes` - This is where you can customise the look and feel of your site. Clone the `default` directory to make a new theme and off you go!
## Roadmap
Possible Graaff enhancements.
* Yeoman generator.
* WYSWIWYG editor.