README: Prerequisites, building and credits

This commit is contained in:
Ismo Vuorinen
2013-06-25 12:08:47 +03:00
parent 04efa176b2
commit 09d5ad02ac

View File

@@ -5,13 +5,30 @@ Flight CO2 emission calculator.
Uses [Grunt: The JavaScript Task Runner](http://gruntjs.com/getting-started).
Dependencies
## Installation ##
### Prerequisites ###
- Webserver that runs PHP to poll the airport data
- MySQL server to hold the data
- [npm](https://npmjs.org), [bower](http://bower.io) and [grunt](http://gruntjs.com) to fetch dependencies and to build the project
Lentolaskuri has been tested and build using tested on [MAMP](http://www.mamp.info) and [LAMP](http://en.wikipedia.org/wiki/LAMP_\(software_bundle\)) stack.
### Dependencies ###
```
npm install && bower install
```
Building the project
### Building the project ###
```
grunt server # Start development server
grunt # Build minified and optimized version for release
```
## Credits ##
- Build by [Juho Teperi](https://github.com/Deraen) in 2013 while working for [Ekokumppanit Oy](http://www.ekokumppanit.fi)
- Currently maintained by [Ismo Vuorinen](https://github.com/ivuorinen)
Airport data comes from [OpenFlights.org](http://openflights.org) ([airports.dat](http://sourceforge.net/p/openflights/code/HEAD/tree/openflights/data/airports.dat), [AGPL](http://www.gnu.org/licenses/agpl.html))