https://github.com/crell/joindinaudit

https://github.com/crell/joindinaudit

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/crell/joindinaudit
• Owner: Crell
• Created: 2015-08-24T19:55:13.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-25T21:09:16.000Z (about 9 years ago)
• Last Synced: 2024-04-14T18:31:52.083Z (7 months ago)
• Language: PHP
• Size: 203 KB
• Stars: 3
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Audit tool for Joind.in

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

This is a simple and straightforward tool for scraping data out of Joind.in 

and running some basic analysis on it.  For more background, see my blog post:

http://www.garfieldtech.com/blog/php-conference-data

## Setup

Clone down the repository, then run `composer install` to grab a few dependencies.

You will need to create a local MySQL database, and set up an Environment variable

for its database credentials. The database user will need full access to that

database.

````

$ export joindin_db=mysql://user:pass@localhost/yourdbname

````

## Usage

There are four scripts to run, in the repository root:

### `php init.php`

Run this once to create the database tables in the database defined above. You

will need to run it once before each time you run `download.php`, as that script

needs an empty database.

### `php download.php`

Run this to download the full available dataset from Joind.in.  It will provide

some basic output along the way.  On my system it takes about 4 minutes, but 

your download speed may vary.

### `php derive.php`

This script generates some derived data that is slow to calculate, and stores

it in the database.  It generates no output when everything works properly.

### `php report.php`

This script actually produces the report output. It produces a very simple HTML

page called results.html, in the project root.  That's where all the useful 

data can be seen. :-)

## Contributing

Want to add another report?  PRs welcome. :-)

Keep using the same format and tool chain in `report()` as the existing code, for

consistency.  If you need to add more derived tables or columns, modify `derive.php`

as needed, again keeping the same structure and pattern.

## License

This tool is copyright 2015 Larry Garfield and released under the MIT license.

Vendored packages are under their own respective licenses.