Skip to content

Commit

Permalink
Merge pull request #13 from M2GIL/dev
Browse files Browse the repository at this point in the history
Dev
  • Loading branch information
AnthoGdn committed Apr 8, 2017
2 parents df712bd + 31bc184 commit 7fd719a
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# Iataaa Server
Iataaa Server is web platform which manages draught game beetween web services.

Iataaa Server is web platform to manage draughts AI. The name IAtaaa stands for the IA (Intelligence Artificielle in french) acronym and the Yatta japanese word for "We did it".

## Requirements

You need Maven on your system to run the platform. Maven is a tool for Java projects. Install it on your system using [this documentation](https://maven.apache.org/install.html). Make sure to have the mvn command on your path.

## Getting Started

### Building the project
Execute `mvn clean install` in the root directory to build maven project.

### Deploy the project
Execute `mvn spring-boot:run` in the root directory to deploy spring boot project.
Execute `mvn clean install` in the root directory to build the Maven project.

### Run the project

Navigate to http://localhost:8080.
Execute `mvn spring-boot:run` in the root directory to run the Spring-Boot project.
You need the [IAtaaa-client](https://github.com/M2GIL/IAtaaa-server) interface to add AI and run a game. You can also develop your own interface using the Web Service and Websocket provided by the server.

You can to change the default port in `/src/main/resources/application.properties`
The port can be configured in the `src/main/resources/application.properties` file.

## Documentation
* [See the docs](https://github.com/M2GIL/IAtaaa-server/wiki/Communication)

* [See the docs](https://github.com/M2GIL/IAtaaa-server/wiki)

0 comments on commit 7fd719a

Please sign in to comment.