Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scify/talk-and-play-marketplace
A Web application for crowdsourcing content for the Talk And Play app.
https://github.com/scify/talk-and-play-marketplace
assistive-technology clean-code hacktoberfest laravel laravel-framework mvc mysql php pint vue vuejs
Last synced: 3 months ago
JSON representation
A Web application for crowdsourcing content for the Talk And Play app.
- Host: GitHub
- URL: https://github.com/scify/talk-and-play-marketplace
- Owner: scify
- License: apache-2.0
- Created: 2021-05-17T07:19:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T20:36:44.000Z (3 months ago)
- Last Synced: 2024-11-05T21:32:27.162Z (3 months ago)
- Topics: assistive-technology, clean-code, hacktoberfest, laravel, laravel-framework, mvc, mysql, php, pint, vue, vuejs
- Language: PHP
- Homepage: https://talkandplay.scify.org/
- Size: 12.5 MB
- Stars: 2
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Talk & Play Marketplace Web Application
[](https://img.shields.io/github/issues/scify/Talk-And-Play-Marketplace)
[](https://img.shields.io/github/stars/scify/Talk-And-Play-Marketplace)
[](https://img.shields.io/github/forks/scify/Talk-And-Play-Marketplace)
[](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 10 Web Application for Creating content for the Talk & Play application
[Project URL](https://crowdsourcing.scify.org/)
# Installation Instructions:
## First time install (setup database and install dependencies)
0. Make sure PHP 8.1 (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
It is very easy to install multiple versions of NodeJS and npm, by using [Node Version Manager (nvm)](https://github.com/creationix/nvm).
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.
## Crontab configuration (for production/staging server)
```text
# For more information see the manual pages of crontab(5) and cron(8)
#
# m h dom mon dow command
* * * * * cd /home/project_talkandplay/www/talkandplay.scify.org/ && php artisan schedule:run >> /dev/null 2>&1
```
## 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:
## 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/tnpmarketplace.conf
% sudo nano /etc/apache2/sites-available/tnpmarketplace.conf
ServerName dev.tnpmarketplace
ServerAlias dev.tnpmarketplace
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:
```
% cd /etc/apache2/sites-enabled && sudo ln -s ../sites-available/tnpmarketplace.conf
```
Enable mod_rewrite, mod_ssl and restart apache:
```
% sudo a2enmod rewrite && sudo a2enmod ssl && sudo service apache2 restart
```
Fix permissions for storage directory:
```bash
sudo chown -R user:www-data storage
chmod 775 storage
cd storage/
find . -type f -exec chmod 664 {} \;
find . -type d -exec chmod 775 {} \;
```
Or run the `set-file-permissions.sh` script.
Change hosts file so dev.tnpmarketplace points to to localhost
```$xslt
sudo nano /etc/hosts
127.0.0.1 dev.tnpmarketplace
```
## 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"