https://github.com/lambdacasserole/flatfolio

Flat file art e-portfolio.
https://github.com/lambdacasserole/flatfolio

Last synced: 12 days ago
JSON representation

Flat file art e-portfolio.

• Host: GitHub
• URL: https://github.com/lambdacasserole/flatfolio
• Owner: lambdacasserole
• License: mit
• Created: 2014-09-23T22:21:34.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-10-07T13:21:39.000Z (about 7 years ago)
• Last Synced: 2024-10-10T22:14:56.171Z (about 1 month ago)
• Language: PHP
• Homepage:
• Size: 313 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Flatfolio

Flat file art portfolio website framework based on [my Silex base project](https://github.com/lambdacasserole/silex-base).

I'm presenting here a clean (-ish) starting point for a website written in PHP on Silex with a basic flat file blogging and portfolio system included.

![Screenshot](screenshot_small.png)

## Prerequisites

You'll need to have a web server installed and configured with PHP for this to work. I really recommend [XAMPP](https://www.apachefriends.org/), especially for Windows users. Once you've done that you can proceed.

You'll also need [Node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) installed and working.

## Configuration

A couple of files need changing to get the site working for you.

1. Copy `config.yml.dist` and rename it to `config.yml`. Fill in the fields according to their descriptions and save.

2. Locate `blog.coffee` and fill in the `blogId` and `apiKey` fields to get your blog working.

## Building

Clone the project down and open the folder in your favourite editor. It's a JetBrains PhpStorm project but you can use whichever paid/free software takes your fancy.

Before anything else, note that this project uses the [Composer](https://getcomposer.org/) package manager. Install composer (see their website) and run:

```

composer install

```

Or alternatively, if you're using the PHAR (make sure the `php.exe` executable is in your PATH):

```

php composer.phar install

```

Then, install the npm packages necessary to build and run the website. Run the following in your terminal in the project root directory:

```

npm install

```

This will install [Bower](https://bower.io/) which will allow you to install the assets the website requires (Bootstrap, jQuery etc.) using the command:

```

bower install

```

Gulp will also have been installed. This will compile the [Less](http://lesscss.org/) and [CoffeeScript](http://coffeescript.org/) into CSS and JavaScript ready for production. Do this using the command:

```

gulp

```

This command will need running again every time you make a change to a Less or CoffeeScript file. If you're working on them, run `gulp watch` in a terminal to watch for file changes and compile accordingly.

## Limitations

I'm not a web designer. The site isn't going to bring a tear to your eye with its beauty.