Ozzie

Ozzie is Tighten's open source projects monitor. Each project is assigned a "debt score" based on how many open issues/PRs there are, and how old they are.

Local Installation

Clone the repo (git clone git@github.com:tighten/ozzie.git && cd ozzie)
Install dependencies (composer install && npm install)
Create a GitHub OAuth Application. If you use Valet to serve your application locally, you can use the following settings:
- Application Name: Local Ozzie
- Homepage URL: http://ozzie.test
- Application Description: Local Version of Ozzie
- Authorization Callback URL: http://ozzie.test/callback
Copy the example .env file: cp .env.example .env and modify its settings to match your local install, including the client ID and secret from the previous step
(optional) Copy projects.json.dist to projects.json and modify it for your organization

Note: If you're not using a tool like Laravel Valet, run php artisan serve and visit your site at http://127.0.0.1:8000; you'll also want to modify your GitHub app settings to use http://127.0.0.1:8000 instead of http://ozzie.test

If you plan to use the snapshot feature, you'll also need to create a database table (by default .env looks for one named ozzie) and run the migrations (php artisan migrate).

Projects and Daily Caching

Your list of projects is defined by the projects.json file in your app root. If you don't create one, the system will fall back to projects.json.dist, which also serves as a helpful template for you to create your own projects.json file.

Here's what the structure of the file looks like:

[
    {
        "name": "ozzie",
        "namespace": "tightenco",
        "maintainers": [
            "mattstauffer"
        ]
    },
]

You can see you'll define the GitHub namespace, the GitHub project name, and the GitHub usernames of all of its maintainers.

Daily Caching

Every time the php artisan snapshot:today command is run, it captures the scores for each project (for historical comparison).

If you're using the scheduler, it'll already be scheduled to run every day (see the docs for how to set up the scheduler cron job).

By default, re-running the command on the same day will not update the day's existing snapshots. To override this behavior, use the -f flag, which will both create any missing snapshots for the day and update all existing snapshots for the day.

php artisan snapshot:today -f

Local Development

Compiling the Frontend Assets

Use Laravel Mix to automatically compile JS/CSS on save:

npm run watch

Running the Linter Tools

This project uses PHP-CS-Fixer to fix PHP, Prettier to fix JS, and StyleLint to lint & fix CSS.

To automatically fix PHP:

composer fix

To automatically fix JS:

npm run fix-js

To automatically fix CSS:

npm run fix-css

Contributing

Please see CONTRIBUTING for details.

Credits

All Contributors

License

The MIT License (MIT). Please see LICENSE for details.

jubayerarefin/ozzie