https://github.com/donejs/bitballs
A basketball tourney application.
https://github.com/donejs/bitballs
Last synced: about 1 month ago
JSON representation
A basketball tourney application.
- Host: GitHub
- URL: https://github.com/donejs/bitballs
- Owner: donejs
- License: mit
- Created: 2015-07-22T04:18:47.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-03-18T17:45:15.000Z (about 5 years ago)
- Last Synced: 2025-03-29T01:41:20.259Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://donejs.com/bitballs.html
- Size: 6.93 MB
- Stars: 11
- Watchers: 22
- Forks: 17
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
@page bitballs Bitballs
@group bitballs.components Components
@group bitballs.clientModels Client Models
@group bitballs.services Services
@group bitballs.serviceModels Service Models
@hide contents
[](https://travis-ci.org/donejs/bitballs)
Bitballs is a [DoneJS](https://donejs.com) app that enables users to coordinate
the players, teams, games, rounds and recordings of a basketball tournament.
It also serves as an example of how to use DoneJS with sessions, user
privileges, RESTful services, and ORM models.
To run the Bitballs app locally, run its tests, or generate its documentation
follow the steps outlined below.
- [Setup Environment](#setup-environment)
- [Installing PostgreSQL on OSX](#installing-postgresql-on-osx)
- [Installing PostgreSQL on Linux](#installing-postgresql-on-linux)
- [Installing PostgreSQL on Windows](#installing-postgresql-on-windows)
- [Download Source](#download-source)
- [Install Dependencies](#install-dependencies)
- [Prepare the Database](#prepare-the-database)
- [Start the Server](#start-the-server)
- [Register a User](#register-a-user)
- [Enjoy](#enjoy)
### Setup Environment
Make sure you have installed:
- [Node 5](https://nodejs.org/en/download/)
- NPM 3 *(packaged with Node)*
- [PostgreSQL](https://www.postgresql.org/download/)
#### Installing PostgreSQL on OSX
On a Mac, the easiest way to install and configure [PostgreSQL](https://www.postgresql.org)
is using the [brew](https://brew.sh/) utility:
```
brew install postgresql
```
Pay special attention to the end of the [brew](https://brew.sh/) command's
output, which includes instructions on how to start `postgres`:
```
To load postgresql:
launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
Or, if you don't want/need launchctl, you can just run:
postgres -D /usr/local/var/postgres
```
The provided `launchctl` command ensures the `postgres` process is always
running, even after a system restart. The alternative `postgres` command
starts the `postgres` process manually.
We recommend the `launchctl` option. If desired, `postgres` can be
stopped and uninstalled by running:
```
brew uninstall postgresql
```
#### Installing PostgreSQL on Linux
*Coming Soon*
#### Installing PostgreSQL on Windows
Download and use the graphical installer available on [postgresql.org](http://www.postgresql.org/download/windows/). Make sure you host it listen to port `5432`.
Open `pg_hba.conf`, which should be in _C:\Program Files\PostgreSQL\9.5\data_, and change from `md5` authentication to `trust`. For example, change:
> host all all 127.0.0.1/32 md5
to:
> host all all 127.0.0.1/32 trust
`trust` should not be used in a production environment. We are only using it here as a substitute for the `peer` mode available in UNIX environments. Read more about it [here](http://www.postgresql.org/docs/9.5/static/auth-methods.html).
Finally, using `pgAdmin III` graphical database manager, which should have been installed with `postgres`, create a `bitballs` database.
### Download Source
Clone this repo using git:
```
git clone https://github.com/donejs/bitballs.git
```
Navigate to the repository's directory
```
cd bitballs
```
### Prepare the Database
Make sure the `postgres` process is running:
```
ps | grep postgres
```
You should see "postgres -D" among the output:
```
92831 ttys000 0:00.02 postgres -D /usr/local/var/postgres
92856 ttys000 0:00.00 grep postgres
```
With that confirmed we can create the database that the bitballs app
will persist its data to:
```
createdb bitballs
```
### Install Dependencies
To install the project's JavaScript dependencies run:
```
npm install
```
Additionally DoneJS's command line utilities need to be installed globally:
```
npm install -g donejs-cli
```
### Start the Server
With all the prerequisite setup completed the server can be started by running:
```
donejs develop
```
### Register a User
Navigate to [http://localhost:5000/register](http://localhost:5000/register)
in your browser and follow the instructions.
### Enjoy
You're finished! Explore some of the app's features:
- Live reload (`donejs develop`)
- Run the tests (`donejs test`)
- Generate the documentation (`donejs document`)