https://github.com/mcrumm/wordy-api

Example project to showcase Guzzle Service Descriptions
https://github.com/mcrumm/wordy-api

Last synced: 27 days ago
JSON representation

Example project to showcase Guzzle Service Descriptions

• Host: GitHub
• URL: https://github.com/mcrumm/wordy-api
• Owner: mcrumm
• License: apache-2.0
• Created: 2014-04-21T15:33:06.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-04-21T16:59:45.000Z (over 10 years ago)
• Last Synced: 2024-05-02T01:20:49.230Z (6 months ago)
• Size: 172 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wordy API

An example project showcasing the features of [Guzzle](http://guzzlephp.org) Service Descriptions.

## Getting Started

1. Create a config file.

2. Installing package dependencies with `composer install`.

3. Generate a Seed File

### Configuration

Copy `config/config.php.dist` to `config/config.php` and modify it suit your environment.

### Installing Dependencies

First, install composer:

```bash

$ cd /path/to/wordy-api

$ curl -sS https://getcomposer.org/installer | php

```

Next, install project dependencies:

```bash

$ cd /path/to/wordy-api

$ php composer.phar install

```

### Grnerate a Seed File

The following will generate an initial seed file, which should keep the API from throwing undue errors.

```

bin/console seed:generate

```

## Deployment

### PHP 5.4

If you're using PHP 5.4+, you can run the example API using the built-in web server. Here's the command:

```

php -S localhost:8787 -t web web/index.php

```

### Other

Explore the [Silex Docs](http://silex.sensiolabs.org/doc/web_servers.html) for more information on setting up other web servers.