Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tighten/ozzie
Open source project monitor for Tighten
https://github.com/tighten/ozzie
agency hacktoberfest laravel open-source ozzie
Last synced: 7 days ago
JSON representation
Open source project monitor for Tighten
- Host: GitHub
- URL: https://github.com/tighten/ozzie
- Owner: tighten
- License: mit
- Created: 2017-09-29T14:09:43.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T22:39:47.000Z (about 1 month ago)
- Last Synced: 2025-01-02T12:09:54.224Z (14 days ago)
- Topics: agency, hacktoberfest, laravel, open-source, ozzie
- Language: PHP
- Homepage: https://ozzie.tighten.co
- Size: 14.8 MB
- Stars: 57
- Watchers: 8
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
----
# Ozzie
[](https://github.com/tighten/ozzie/actions?query=workflow%3A%22Run+Tests%22)
**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
### MacOS - Valet
1. Clone the repo (`git clone [email protected]:tighten/ozzie.git && cd ozzie`)
2. Install dependencies (`composer install && npm install`)
3. Run `valet secure` to use `https` for the local domain
4. Update `APP_URL` in `.env` to use your local valet TLD. By default, it will use `https://ozzie.test`
3. Create a [GitHub OAuth Application](https://github.com/settings/developers). If you use Valet to serve your application locally, you can use the following settings:
- Application Name: `Local Ozzie`
- Homepage URL: `https://ozzie.test`
- Application Description: `Local Version of Ozzie`
- Authorization Callback URL: `https://ozzie.test/auth/callback`
4. 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
5. Run `php artisan key:generate`
6. Create a database (by default `.env` looks for one named `ozzie`) and run the migrations (`php artisan migrate`)
7. Fetch the projects list (into the database) by using the `projects:fetch` command. Alternatively, you can seed your `projects` table using a `projects.json` file at the root of the project (see below for more info).
9. Fetch all projects' stats for the first time using `stats:fetch`
### Sail - Docker
*ensure you have docker installed and running*
For the following steps, you'll need to have the `sail` command available. You can alias it by running:
```shell
alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'
```
[For more info around aliasing check this part of the docs](https://laravel.com/docs/10.x/sail#configuring-a-shell-alias)
1. Clone the repo (`git clone [email protected]:tighten/ozzie.git && cd ozzie`)
2. Install dependencies
```shell
docker run --rm \
-u "$(id -u):$(id -g)" \
-v "$(pwd):/var/www/html" \
-w /var/www/html \
laravelsail/php82-composer:latest \
composer install --ignore-platform-reqs
```
```shell
sail npm install
```
3. Create a [GitHub OAuth Application](https://github.com/settings/developers). If you use Valet to serve your application locally, you can use the following settings:
- Application Name: `Local Ozzie`
- Homepage URL: `http://localhost`
- Application Description: `Local Version of Ozzie`
- Authorization Callback URL: `http://localhost/auth/callback`
4. 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
5. Run `sail artisan key:generate`
6. Run the migrations (`sail artisan migrate`)
7. Fetch the projects list (into the database) by using the `projects:fetch` command. Alternatively, you can seed your `projects` table using a `projects.json` file at the root of the project (see below for more info).
8. Fetch all projects' stats for the first time using `stats:fetch`
> 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
## Projects and Daily Caching
If you'd like to seed `projects` manually, you can do so using 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:
```json
[
{
"name": "ziggy",
"namespace": "tighten",
"packagist": "tightenco/ziggy",
"maintainers": [
"mattstauffer"
]
},
]
```
Each project in this file will need its GitHub namespace, the GitHub project name, and the GitHub usernames of all of its maintainers.
### Changing or Adding Projects
Using the GitHub API, new public repos added to the organization will be added automatically (checked daily) through the `projects:fetch` command.
If you're doing it manually, any changes to projects needs to happen in `projects.json` _first_. Migrating and seeding tables fresh will update the `projects` table with the new info, and the next call of `php artisan stats:fetch` will re-populate project stats.
1. Make a change to `projects.json`
2. Re-run the seeder: `php artisan db:seed`
3. Fetch all project stats: `php artisan stats:fetch`
### Daily Caching
Every time the `php artisan stats:snapshot` 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](https://laravel.com/docs/scheduling)).
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.
```bash
php artisan stats:snapshot -f
```
## Local Development
### Compiling the Frontend Assets
Use Vite to automatically compile JS/CSS on save:
```bash
npm run dev
```
### Running the Linter Tools
This project uses [Duster](https://github.com/tighten/duster) to fix PHP, [Prettier](https://prettier.io/) to fix JS, and [StyleLint](https://stylelint.io/) to lint & fix CSS.
To automatically fix PHP:
```bash
composer fix
```
To automatically fix JS:
```bash
npm run fix-js
```
To automatically fix CSS:
```bash
npm run fix-css
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [All Contributors](https://github.com/tighten/ozzie/graphs/contributors)
## License
The MIT License (MIT). Please see [LICENSE](LICENSE.md) for details.