{"id":14974762,"url":"https://github.com/april-knights/squire","last_synced_at":"2026-02-09T22:04:56.633Z","repository":{"id":37638211,"uuid":"242850895","full_name":"april-knights/Squire","owner":"april-knights","description":"Core files for the Squire 2 web application.","archived":false,"fork":false,"pushed_at":"2025-02-19T21:42:12.000Z","size":6995,"stargazers_count":2,"open_issues_count":23,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-02T00:35:33.719Z","etag":null,"topics":["april-fools","laravel","laravel6","reddit","squire"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/april-knights.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-24T21:47:24.000Z","updated_at":"2024-05-16T17:06:22.000Z","dependencies_parsed_at":"2024-05-16T18:27:11.960Z","dependency_job_id":"5d5f5d84-5f2b-4ce2-b8c2-be0a59f9b095","html_url":"https://github.com/april-knights/Squire","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/april-knights%2FSquire","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/april-knights%2FSquire/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/april-knights%2FSquire/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/april-knights%2FSquire/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/april-knights","download_url":"https://codeload.github.com/april-knights/Squire/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241444048,"owners_count":19963749,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["april-fools","laravel","laravel6","reddit","squire"],"created_at":"2024-09-24T13:51:02.808Z","updated_at":"2026-02-09T22:04:56.606Z","avatar_url":"https://github.com/april-knights.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Squire\n\n## Dev Setup (using Docker)\n1. Install Git and Docker (with Compose)\n2. Clone the repository using `git clone https://github.com/april-knights/Squire.git`.\n3. Create a [Reddit application](https://www.reddit.com/prefs/apps/) and set the redirect URI to `http://localhost/login/reddit/callback`.\nThe other fields can be set to anything\n4. Copy `.env.default` to `.env` and modify the Reddit client ID and secret to the values you got from Reddit\n5. Run `docker compose up --build` in the `.docker` directory. Once everything is initialized properly, you can reach the page at http://localhost/\n6. While the project is running, run the following commands in another window (in the `.docker` directory) to have better coding assistance:\n```shell\ndocker compose exec app php artisan ide-helper:generate\ndocker compose exec app php artisan ide-helper:meta # Only if you use PHPStorm\ndocker compose exec app php artisan ide-helper:models\n```\n\n## Dev Setup (running directly)\n1. Install `git`, `php`, `composer` and `npm`.\n2. Clone the repository using `git clone https://github.com/april-knights/Squire.git`.\n3. Enter the `Squire` directory and run `composer install`.\n4. Copy `.env.example` to `.env` and modify whatever you need.\n5. Start the development server using `php artisan serve`\n6. While the project is running, run the following commands in another window (in the `.docker` directory) to have better coding assistance:\n```shell\nphp artisan ide-helper:generate\nphp artisan ide-helper:meta # Only if you use PHPStorm\nphp artisan ide-helper:models\n```\n\n### Compiling CSS/JS changes\n1. Install the required Javascript dependencies using `npm install`.\n2. Run `npm run dev` to recompile css and js files.\n\n### Automatically recompile CSS/JS and refresh browser\n1. Change the redirect_uri in `.env` and on reddit to `127.0.0.1:3000`.\n2. Run `npm run watch`. Whenever you make a change to the application, your browser is automatically reloaded.\n\n## Deployment\n0. Properly set up your webserver.\n1. Install `git`, `php` and `composer`.\n2. Clone the repository using `git clone https://github.com/april-knights/Squire.git`.\n3. Enter the `Squire` directory and run `composer install --optimize-autoloader --no-dev`.\n4. Install the required Javascript dependencies using `npm install`.\n5. Run `npm run prod` to generate the minified static files.\n6. Copy `.env.prod` to `.env` and set up the DB connection and Reddit API.\n7. Run `php artisan key:generate` to generate an app key for secure session storage.\n8. Run `php artisan config:cache` to combine all config files into a single one. Rerun this whenever you make changes to `.env`!\n9. Point your webserver to `squire/public`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapril-knights%2Fsquire","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapril-knights%2Fsquire","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapril-knights%2Fsquire/lists"}