Skip to content

Commit

Permalink
Resolves #187 - Removes Legacy Documentation
Browse files Browse the repository at this point in the history
Removes the old outdated documentation for the README.md which has caused confusion. Cleans up documentation.
  • Loading branch information
Michael Hiiva authored Jun 20, 2021
1 parent 7d092da commit d37ca5d
Showing 1 changed file with 3 additions and 51 deletions.
54 changes: 3 additions & 51 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,7 @@

## Overview
An app to display users, games, tournaments, and ratings information on the AGA website.
A port of the old eurogo Games Database to python, for the AGA

- agagd_core/ --
- agagd/ --
The AGAGD is a port of the old EuroGO Games Database to python developed for the [American Go Association (AGA)](usgo.org).

## Development

Expand All @@ -18,51 +15,6 @@ The AGAGD project uses pre-commit for some basic linting and mostly follows [bla

### Getting started

**Important: running the agagd locally now requires the `schema.sql` which can be found in [USGO SQL Schema's Repo](https://github.com/usgo/usgo-sql-schemas).**

*A new docker-based development approach is also available, see [docker.md](docker.md) for details.*

The first step is to install `mysql` and create an `agagd` database. Then load the current database schema snapshot, as well
as the SQL files in `sql/`, into the `agagd` database, e.g.:

~~~
$ mysql agagd < schema.sql
$ for file in sql/*; do
$ mysql agagd < $file
$ done
~~~

Next set up the app environment. Virtualenv and virtualenvwrapper are recommended.

~~~
$ mkvirtualenv agagd
$ workon agagd
$ cd PATH_TO_REPO_ROOT
$ pip install -r requirements_dev.txt
$ cd agagd/
$ cp local_settings.py.sample local_settings.py
~~~

Edit your `local_settings.py` to match your database settings.

~~~
$ python manage.py loaddata fake_data
$ python manage.py runserver
~~~

After the above, you should be able to see the site up and running at http://localhost:8000

### development needs
1. It'd really help if we had a sanitized version of the database we could use,
with shuffled AGAIDs, random names & chapters, and a few sample tournaments.

### Roadmap
**Important: running the agagd locally now requires the `schema.sql` which can be found in [USGO SQL Schema's Repo](https://github.com/usgo/usgo-sql-schemas). The` schema.sql` file needs to be place in the main directory of the locally cloned AGAGD repo.**

1. Get a basic set of models & views working with the existing DB. Check!
2. Focus on the views around viewing player cards and their game history. Done!
3. Get the tournament/wall list re-creation features up. Faked!
4. Style things up nice-like. A first draft!
5. Declare victory
6. extend to put a frontend on the ratings workings of Bresler et al.
7. Provide online game submissions
8. Document game submission protocol for use with other servers.
The AGAGD application uses docker for local development. Information about how to get up and running see [docker.md](docker.md) for details.

0 comments on commit d37ca5d

Please sign in to comment.