Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/april-knights/squire
Core files for the Squire 2 web application.
https://github.com/april-knights/squire
april-fools laravel laravel6 reddit squire
Last synced: about 1 month ago
JSON representation
Core files for the Squire 2 web application.
- Host: GitHub
- URL: https://github.com/april-knights/squire
- Owner: april-knights
- License: gpl-3.0
- Created: 2020-02-24T21:47:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T17:07:25.000Z (6 months ago)
- Last Synced: 2024-10-11T11:04:59.308Z (about 1 month ago)
- Topics: april-fools, laravel, laravel6, reddit, squire
- Language: PHP
- Homepage:
- Size: 6 MB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://www.reddit.com/prefs/apps/) 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:
```shell
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:
```shell
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
0. Properly set up your webserver.
1. Install `git`, `php` and `composer`.
2. Clone the repository using `git clone https://github.com/april-knights/Squire.git`.
3. Enter the `Squire` directory and run `composer install --optimize-autoloader --no-dev`.
4. Install the required Javascript dependencies using `npm install`.
5. Run `npm run prod` to generate the minified static files.
6. Copy `.env.prod` to `.env` and set up the DB connection and Reddit API.
7. Run `php artisan key:generate` to generate an app key for secure session storage.
8. Run `php artisan config:cache` to combine all config files into a single one. Rerun this whenever you make changes to `.env`!
9. Point your webserver to `squire/public`.