https://github.com/hfaran/livespool

An Elimination Game of Billiards
https://github.com/hfaran/livespool

Last synced: 3 months ago
JSON representation

An Elimination Game of Billiards

• Host: GitHub
• URL: https://github.com/hfaran/livespool
• Owner: hfaran
• License: agpl-3.0
• Created: 2014-01-19T07:29:55.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-12-04T23:04:20.000Z (about 9 years ago)
• Last Synced: 2024-10-04T21:38:28.760Z (3 months ago)
• Language: Python
• Homepage:
• Size: 511 KB
• Stars: 6
• Watchers: 6
• Forks: 5
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
`Lives Pool`

================

[![Build Status](https://travis-ci.org/hfaran/LivesPool.png)](https://travis-ci.org/hfaran/LivesPool)

[![Coverage Status](http://coveralls.io/repos/hfaran/LivesPool/badge.png?branch=master)](https://coveralls.io/r/hfaran/LivesPool?branch=master)

[![Stories in Ready](https://badge.waffle.io/hfaran/LivesPool.png?label=in_progress)](https://waffle.io/hfaran/LivesPool)

## Getting Started

```bash

./install.bash

src/cutthroats.py

# Visit localhost:9700

```

## Running with ``supervisord``

```bash

# If supervisord isn't already going, start it

supervisord -c supervisord.conf

# We can use the following commands to get status, start, stop, restart

supervisorctl status

supervisorctl start all

supervisorctl restart all

supervisorctl stop all

# These commands must all be run from the root directory

```

## Running Tests

### Back-end tests

```bash

./runtests.bash

```

### Front-end tests

Front-end functional tests literally use `supervisorctl` to start the server to talk to.

Therefore, you must have LivesPool "installed" already (i.e., have run `install.bash`).

Additionally, manually sign up a user with username "test" and password "test".

```bash

# Must be run from the root directory of the repository

src/tests/frontend_test.py

```

## API Documentation

* [Markdown](https://github.com/hfaran/LivesPool/blob/master/docs/API_Documentation.md)

* [HTML](http://hfaran.github.io/LivesPool/API_Documentation/)