Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scify/game-travelers-laravel
A fun and intuitive game, for children with disabilities!
https://github.com/scify/game-travelers-laravel
disabled-people game laravel laravel-framework laravel9 web
Last synced: about 12 hours ago
JSON representation
A fun and intuitive game, for children with disabilities!
- Host: GitHub
- URL: https://github.com/scify/game-travelers-laravel
- Owner: scify
- License: apache-2.0
- Created: 2023-01-19T11:43:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T06:34:00.000Z (5 months ago)
- Last Synced: 2024-06-18T07:48:20.124Z (5 months ago)
- Topics: disabled-people, game, laravel, laravel-framework, laravel9, web
- Language: Blade
- Homepage: https://taxidiotes.scify.org/
- Size: 208 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Taxidiotes Game Web Application
[](https://github.com/dwyl/goodparts "JavaScript The Good Parts")
[](https://github.com/dwyl/esta/issues)
[](https://opensource.org/licenses/Apache-2.0)
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[](https://GitHub.com/scify)
Laravel 9 Web Application for the Taksidiotes Game Web app
[Project URL](https://taxidiotes.scify.org/)
# Installation Instructions:
## Pre-initialization steps
After cloning the project, create an .env file (should be a copy of .env.example),
containing the information about your database name and credentials:
```bash
cp .env.example .env
```
Take a look at the `.env` file that was created. You may need to update the `DB_*` variables, in order to set up the DB
connection.
Also, make sure that the `APP_URL` is set to the correct domain and port that you will be using.
## First time install (setup database and install dependencies)
0. Make sure php 8.0 (or newer) is installed.
1. After cloning the project, create an .env file (should be a copy of .env.example),
containing the information about your database name and credentials.
Then run ```php artisan migrate``` to create the DB schema and
```php artisan db:seed``` in order to insert the starter data to the DB
2. Install laravel/back-end dependencies
```bash
composer install
```
3. Front-end dependencies
If you are using [`nvm`](https://github.com/nvm-sh/nvm), run this command in order to sync to the correct NodeJS version for the project:
```bash
nvm use
```
Then, install and compile the front-end dependencies:
```bash
npm install
npm run dev
```
4. Create the symbolic link for user-uploaded files.
```bash
php artisan storage:link
```
in order to link the `/public/storage` folder with the `/storage/app/public` directory.
## SEO - Generate Sitemap
This application uses [Spatie - Laravel Sitemap](https://github.com/spatie/laravel-sitemap) plugin, in order to create
the `public/sitemap.xml` file (which is excluded from git), that will be crawled by the search engines.
In order to run the generator for the current application installation, run the embedded Laravel command:
```bash
php artisan sitemap:generate
```
## PHP code style - Laravel Pint
This application uses [Laravel Pint](https://laravel.com/docs/9.x/pint) in order to perform code-style.
In order to run the styler, run :
```bash
./vendor/bin/pint --test -v # the --test will not do any changes, it will just output the changes needed
./vendor/bin/pint -v # this command will actually perform the code style changes
```
## Apache configuration example:
```
% sudo touch /etc/apache2/sites-available/taxidiotes.conf
% sudo nano /etc/apache2/sites-available/taxidiotes.conf
ServerName dev.taxidiotes
ServerAlias dev.taxidiotes
DocumentRoot "/home/path/to/project/public"
Require all granted
AllowOverride all
ErrorLog ${APACHE_LOG_DIR}/error.log
CustomLog ${APACHE_LOG_DIR}/access.log combined
```
Make the symbolic link:
```bash
% cd /etc/apache2/sites-enabled && sudo ln -s ../sites-available/taxidiotes.conf
```
Enable mod_rewrite, mod_ssl and restart apache:
```bash
% sudo a2enmod rewrite && sudo a2enmod ssl && sudo service apache2 restart
```
Fix permissions for storage directory:
```bash
sudo chown -R ${USER}:www-data storage
sudo chmod 775 storage
cd storage/
sudo find . -type f -exec chmod 664 {} \;
sudo find . -type d -exec chmod 775 {} \;
```
Or run the `set-file-permissions.sh` script (needs sudo):
```bash
sudo ./set-file-permissions.sh www-data ${USER} .
```
Change hosts file so dev.taxidiotes points to localhost:
```$xslt
sudo nano /etc/hosts
127.0.0.1 dev.taxidiotes
```
## About the music files
The directories under `resources/audio/fx` and `resources/audio/music` should contain audio (.mp3) files that are not checked in source control, because of copyright issues.
Please check `resources/audio/fx/README.md` and `resources/audio/music/README.md` , in order to see which files you should download and put there.
In order to upload the files in a remote environment (staging or production server, for example), you can use `scp`:
```bash
scp -r -P 1337 /path/to/local/fx/* project_taxidiotes@server:/home/project_taxidiotes/www/resources/audio/fx
scp -r -P 1337 /path/to/local/music/* project_taxidiotes@server:/home/project_taxidiotes/www/resources/audio/music
```
## How to debug
- Install and configure Xdebug on your machine
- At Chrome
install [Xdebug helper](https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc?utm_source=chrome-app-launcher-info-dialog)
- At PhpStorm/IntelliJ click the "Start listening for PHP debug connections"
## How to contribute
- Send us a pull request describing your improvements/fixes/features