AprilKnights/Squire
1
0
Fork 0
mirror of https://github.com/april-knights/Squire.git synced 2025-12-05 22:20:55 +00:00
Code Issues Projects Releases Packages Wiki Activity
Core files for the Squire 2 web application.
210 commits 11 branches 0 tags 7.1 MiB
Find a file
Exact
Gryph667 864ace5e36
 Updating socialiteproviders from 4.1 to 4.2
2025-12-05 03:53:14 -05:00
.docker Update to Laravel 10 2023-06-23 14:18:40 +02:00
.github Create composer validation workflow 2020-03-12 13:38:19 +00:00
app Fix skill/division update 2024-05-16 01:06:05 +02:00
bootstrap Set up laravel project 2020-02-25 01:07:25 +01:00
config Update to Laravel 7 2022-10-11 19:20:41 +02:00
database Update to Laravel 9 2022-10-11 20:02:56 +02:00
public Creating Division Banner folder 2022-06-26 22:01:51 -04:00
resources Fix skill/division update 2024-05-16 01:06:05 +02:00
routes Implement user deletion 2020-04-01 02:58:59 +02:00
storage Set up laravel project 2020-02-25 01:07:25 +01:00
tests Set up laravel project 2020-02-25 01:07:25 +01:00
.editorconfig Set up laravel project 2020-02-25 01:07:25 +01:00
.env.default Update to Laravel 10 2023-06-23 14:18:40 +02:00
.env.prod Improve production setup instructions 2020-03-15 02:53:17 +01:00
.gitattributes Set up laravel project 2020-02-25 01:07:25 +01:00
.gitignore Begin converting to Eloquent models 2022-09-17 18:20:27 +02:00
.styleci.yml Set up laravel project 2020-02-25 01:07:25 +01:00
artisan Set up laravel project 2020-02-25 01:07:25 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-02-24 21:06:32 -05:00
composer.json Updating socialiteproviders from 4.1 to 4.2 2025-12-05 03:53:14 -05:00
composer.lock Update dependencies 2024-05-16 19:05:15 +02:00
CONTRIBUTING.md Create CONTRIBUTING.md 2020-02-24 21:00:26 -05:00
CSS Notes File Creation 2020-02-24 17:17:13 -05:00
LICENSE Initial commit 2020-02-24 21:47:25 +00:00
MiscChangeLog.txt Create MiscChangeLog.txt 2020-03-12 01:20:22 -04:00
package-lock.json Add support for JS/CSS generation in Docker 2022-06-26 18:10:00 +02:00
package.json Bump lodash from 4.17.19 to 4.17.21 2021-05-11 04:18:36 +00:00
phpunit.xml Set up laravel project 2020-02-25 01:07:25 +01:00
README.md Remove email/pass interfaces from Knight and add IDE Helper info to README 2022-10-11 15:59:45 +02:00
readme.txt Create readme.txt 2020-03-04 21:57:11 -05:00
server.php Set up laravel project 2020-02-25 01:07:25 +01:00
webpack.mix.js Add support for JS/CSS generation in Docker 2022-06-26 18:10:00 +02:00

README.md

Squire

Dev Setup (using Docker)

  1. Install Git and Docker (with Compose)
  2. Clone the repository using git clone https://github.com/april-knights/Squire.git.
  3. Create a Reddit application and set the redirect URI to http://localhost/login/reddit/callback. The other fields can be set to anything
  4. Copy .env.default to .env and modify the Reddit client ID and secret to the values you got from Reddit
  5. Run docker compose up --build in the .docker directory. Once everything is initialized properly, you can reach the page at http://localhost/
  6. While the project is running, run the following commands in another window (in the .docker directory) to have better coding assistance:
docker compose exec app php artisan ide-helper:generate
docker compose exec app php artisan ide-helper:meta # Only if you use PHPStorm
docker compose exec app php artisan ide-helper:models

Dev Setup (running directly)

  1. Install git, php, composer and npm.
  2. Clone the repository using git clone https://github.com/april-knights/Squire.git.
  3. Enter the Squire directory and run composer install.
  4. Copy .env.example to .env and modify whatever you need.
  5. Start the development server using php artisan serve
  6. While the project is running, run the following commands in another window (in the .docker directory) to have better coding assistance:
php artisan ide-helper:generate
php artisan ide-helper:meta # Only if you use PHPStorm
php artisan ide-helper:models

Compiling CSS/JS changes

  1. Install the required Javascript dependencies using npm install.
  2. Run npm run dev to recompile css and js files.

Automatically recompile CSS/JS and refresh browser

  1. Change the redirect_uri in .env and on reddit to 127.0.0.1:3000.
  2. Run npm run watch. Whenever you make a change to the application, your browser is automatically reloaded.

Deployment

  1. Properly set up your webserver.
  2. Install git, php and composer.
  3. Clone the repository using git clone https://github.com/april-knights/Squire.git.
  4. Enter the Squire directory and run composer install --optimize-autoloader --no-dev.
  5. Install the required Javascript dependencies using npm install.
  6. Run npm run prod to generate the minified static files.
  7. Copy .env.prod to .env and set up the DB connection and Reddit API.
  8. Run php artisan key:generate to generate an app key for secure session storage.
  9. Run php artisan config:cache to combine all config files into a single one. Rerun this whenever you make changes to .env!
  10. Point your webserver to squire/public.