No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app/config
source
.gitignore
LICENSE
README.md
composer.json
sculpin.json
sculpin.lock

README.md

Sculpin Project Hub Skeleton

Use this skeleton to quickly setup and start working on a new project-hub powered by Sculpin.

Installation

This skeleton was designed to be used with Composer and Sculpin. This makes setting up a new project hub easy.

Install Composer

If you have not installed Composer, do that now. I prefer to install Composer globally in ~/bin, but you may also install Composer locally in your current working directory. For this tutorial, I assume you have installed Composer locally.

http://getcomposer.org/doc/00-intro.md#installation

Install the Skeleton

After you install Composer, run this command from the directory in which you want to install your new project-hub project.

composer.phar create-project adambrett/sculpin-project-hub [your-project-name]

Replace [your-project-name] with the desired directory name for your new application.

Install Sculpin

If you have not installed Sculpin, do that now. I prefer to install Sculpin globally in ~/bin, but you may also install Sculpin locally in your current working directory. For this tutorial, I assume you have installed Sculpin locally.

https://sculpin.io/download/

### Sculpin Dependencies

Sculpin comes with an embedded composer for managing Sculpins own dependencies, which is how the theme for this project is included, so once Sculpin is installed and the project created you will need to run

sculpin.phar install

From the root of your project to download the theme.

Basic Usage

One you have everything installed you can run:

sculpin.phar generate --watch --server

Now visit http://localhost:8000 in your browser and you should see your new Sculpin powered project-hub.

To add events, edit app/config/sculpin_site.yml and update the timeline:

timeline:
    2013-08-14:
        Kickoff Meeting:
            View Notes: '#'
    2013-08-09:
        Sign contract:
            View contract: '#'
    2013-08-07:
        Initial Meeting:
            Meeting Notes: '#'
    2013-07-13:
        Initial contact:

The first level is the date in ISO format.

The next level is the event name, you can add as many of these as you like.

Under each event name is a link for the files for that event, if there are any. You can add as many links as you like.

If there are no links for an event, just type the event name followed by a colon : as in the last line of the above example.

Requirements

Contributing

Pull Requests

  1. Fork the php-skeleton repository
  2. Create a new branch for each feature or improvement
  3. Send a pull request from each feature branch to the develop branch

Authors

Adam Brett - http://twitter.com/sixdaysad - http://adamcod.es

License

php-skeleton is licensed under the BSD-3-Clause License - see the LICENSE file for details