https://github.com/hoaian2/college-quiz-app
A Quiz app build with Laravel+React
https://github.com/hoaian2/college-quiz-app
excel laravel php react typescript
Last synced: over 1 year ago
JSON representation
A Quiz app build with Laravel+React
- Host: GitHub
- URL: https://github.com/hoaian2/college-quiz-app
- Owner: HOAIAN2
- License: mit
- Created: 2023-09-24T05:31:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:40:00.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T09:55:29.817Z (almost 2 years ago)
- Topics: excel, laravel, php, react, typescript
- Language: TypeScript
- Homepage: http://andev.great-site.net
- Size: 9.47 MB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# College-Quiz-App
## Technologies
- Laravel 12
- React 19
## Prerequisites
- Nodejs (only for Dev)
- PHP 8.2 or later
- MySQL / MariaDB
## Installation
``` console
git clone https://github.com/HOAIAN2/college-quiz-app.git
```
- Run `./scripts/install.sh` to generate .env file and install libs for both server and client.
- Edit Enviroment variables in .env file.
``` env
DB_CONNECTION=mariadb
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=college-quiz-app
DB_USERNAME=admin
DB_PASSWORD=123456789
````
- Remember to update your correct timezone
``` env
APP_TIMEZONE=UTC
```
- Remember to update demo password if you run application in demo mode.
```env
DEMO=true
DEMO_PASSWORD="123456789"
```
- Create database, seed data
```console
php artisan migrate
```
```console
php artisan db:seed
```
- Build
Some free hosting like infinityfree, 000webhost only allow GET, POST method so you can config override method when call api on client
``` env
VITE_DEV_PORT=3000
VITE_DEV_SERVER_PORT=8000
VITE_OVERRIDE_HTTP_METHOD=true
```
```console
./scripts/build.sh
```
## Editor settings
This project combine both frontend and backend, maybe it some extensions not correctly. Here is my vscode settings for this project:
```json
{
"Laravel.basePath": "backend",
"typescript.tsdk": "./frontend/node_modules/typescript/lib",
}
```
## Deploy
### Free hosting
Run Deploy file to build and compress all necessary files to app.tar.gz
```console
./scripts/deploy.sh
```
You can host front end and backend in 2 domain
```env
VITE_API_HOST=
```
### VPS with Docker
Docker settings save in `docker` directory, `Nginx` connect to `php-fpm` via unix socket instead of normal TCP socket. You can custom `php-fpm` settings by modify the `zz-docker.conf`, but you have to create the file first by copy content from `zz-docker.example.conf`
I'm only setup `Nginx` with `php-fpm` and `Redis` so you have to host your database yourself, or just modify the `docker-compose.yml` or using any other way to host you database.
You can host this application with `docker` by run simple command
```console
./scripts/install.sh --docker # Create docker config files
./scripts/build.sh --docker
docker compose up -d
```
## Cron Job
This application still works even if you do not set up a cron job. But you should set up a cron job to clean up data, files, etc.
Cron job file stored in `docker/crontab`
## Backup database
Use any tool or cli like `mysqldump`, `mariadb-dump`. I already write a NodeJS wrapper base on `mysqldump` for better performance.
## Database Diagram
## Demo
### Dashboard UI
### Students UI
### Create Question UI
### Course UI
### Exam UI
### Take Exam UI
### Setting UI
Full review (Vietnamese) at Youtube: