Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.13 KB
Raw

Halite Contributing Guide

If you find a bug or have a feature request, please open an issue.

Want to help out? Have you implemented a patch or a new feature? Send us a pull request! If you are looking for things to do, check out our open issues.

Common Contributions

Writing a Starter Package

If you'd like to write a starter package for a new language, see this guide.

Adding Your Company or University

Edit this whitelist and send us a pull request. If you need to change your email, head here. We'll make sure to tag all members of your organization who have already signed up.

Folder Contents

  • admin/ - A collection of administrative resources (ex. a technical specification)
  • airesources/ - The language-specific starter kits for writing bots
  • environment/ - The halite game engine
  • tests/ - All of the project's unit and integration tests
  • website/ - The website that hosts the competition. Includes the API that manages the game servers.
  • worker/ - The source for the worker servers that compile bots and run games safely

Installing the website on Ubuntu

Clone the repo:

git clone https://github.com/HaliteChallenge/Halite.git

Run the website install script with root user permissions. This will install php, apache, python (and some python modules), and composer (and some composer packages):

cd website; sudo ./install.sh

Run the database install script with root user permissions. This will install mysql and insert our schema into a database titled Halite.

cd sql; sudo ./install.sh

Create a halite.ini file using your favorite text editor in the root project directory. Place information about your local database setup in there. Your halite.ini file should look like this;

[database]
hostname = 127.0.0.1 
username = YOUR_LOCAL_MYSQL_USERNAME
password = YOUR_LOCAL_MYSQL_PASSWORD
name = Halite