Skip to content

Latest commit

 

History

History
111 lines (71 loc) · 3.28 KB

README.md

File metadata and controls

111 lines (71 loc) · 3.28 KB
Raw

ProjectHub

This project is a PHP version of Brad Frost’s project hub idea.

  1. What is a project hub?
  2. Why would I use a project hub
  3. How to Install
  4. How to Manage Your Projects
  5. How to Contribute
  6. Author & Community

What is a project hub?

Screenshot of ProjectHub, an online project timeline

A project hub is an online project timelines.

It is a tool for keeping track of the progress of a design/development project. The hub lives online (either publically available or password protected), so that everyone involved in the team has access to it. Read more about project hubs on 24 Ways.

Why would I use a project hub?

The benefits of using a project hub:

  • Serves as a centralized place for the project's key design/development materials
  • Easily and visually view project progress
  • Provides an archive for project artifacts

How to Install

ProjectHub use the Model418 library as a storage abstraction layer. So it could be connected to a database instead of the file system.

The dependencies are committed to have a code easy to install, understand and improve.

To start using ProjectHub you have to:

  1. Deploy the files in a folder visible by apache
  2. See the sample project data, via your browser, to check if the installation works
  3. Setup your own project data in the data folder

How to Manage Your Projects

The projects are stored as Yaml files. Every file in the data folder is a different project.

A project is mainly a timeline of project update, which you can join links, like meetings notes or project deliveries.

The code below is a project example file:

name: "My first project"
timeline:
    -
        stamp: "August 14th, 2013"
        content: "Kickoff Meeting"
        links:
            "View notes": "#"
            "View demo": "#"
    -
        stamp: "August 9th, 2013"
        content: "Sign contract"
        links:
            "View contract": "#"
    -
        stamp: "August 7th, 2013"
        content: "Initial meeting"
        links:
            "Meeting Notes": "#"
    -
        stamp: "July 13th, 2013"
        content: "Initial contact"

How to Contribute

  1. Fork the ProjectHub repository
  2. Create a new branch for each feature or improvement
  3. Send a pull request from each feature branch to the master branch

If you don't know much about pull request, you can read the GitHub article.

All pull requests must follow the PSR2 standard.

Author & Community

ProjectHub is under MIT License.
The project hub idea & the HTML template was created by Brad Frost.
The PHP version was created & maintained by Thomas ZILLIOX.

↑ top