diff options
| author | Kevin Hoerr <kjhoerr@protonmail.com> | 2017-09-13 19:19:07 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-13 19:19:07 -0400 |
| commit | 53c385147f40288965a2a0fae5743b690a682c5e (patch) | |
| tree | 38081e2f2e810a0b429cbc117b870b77297de0c1 | |
| parent | f7c01ba8b1231ef64b53e5d20d84135b420a5fd5 (diff) | |
| download | august-offensive-53c385147f40288965a2a0fae5743b690a682c5e.tar.gz august-offensive-53c385147f40288965a2a0fae5743b690a682c5e.tar.bz2 august-offensive-53c385147f40288965a2a0fae5743b690a682c5e.zip | |
Update README.md
| -rw-r--r-- | README.md | 8 |
1 files changed, 7 insertions, 1 deletions
@@ -4,11 +4,17 @@ August Offensive is a game as a web service that enables players to achieve worl The main goal of August Offensive is to enable players to interact with the service only when they are available to do so. Effectively, players do not need to maintain connection to the service for the entirety of the game. To prevent games from deadlocking, a customary time limit is enforced (ex. 96 hours). +## Getting Started + +Getting the code running should be fairly simple. Given you have the properly installed packages (PHP 7.0, PostGreSQL 9.6) there should be few if any configuration changes to existing services. Make sure [your credentials are configured](https://github.com/kjhoerr/august-offensive/wiki/Credentials-for-PGSQL) and try visiting /api/callback at your server - you should get a response if it's set up correctly. + +In order to run tests, install [PHPUnit](https://phpunit.de/) (for PHP 7.0). At the project root, run `phpunit --bootstrap autoload.php test`. + ## Technical Objectives The web service will provide a RESTful API that is written in PHP 7.0 and connects to a PostGreSQL database. This connection will be managed behind an abstraction layer using PDO. The service will handle users and their game sessions. In addition, all PHP code shall follow PSR-1, PSR-2, PSR-4, and PSR-5 coding standards. It is also recommended to try to write code as immutably as possible. -The front-end of this project will be written using [Elm](http://elm-lang.org/) (although this is subject to change). Work on the front-end portion will not begin until August Offensive's web API has reached relative stability. The version for target stability is alpha 1.0.0. +The front-end of this project will be written using [Elm](http://elm-lang.org/) (although this is subject to change). Work on the front-end portion will not begin until August Offensive's web API has reached relative stability. The target version number for stability is 1.0.0. ## Contributing to the Project |