|
| 1 | +# Flash Card Pro |
| 2 | + |
| 3 | +[](https://github.com/ebbbang/flash-card-pro/actions/workflows/tests.yml) |
| 4 | +[](https://coveralls.io/github/ebbbang/flash-card-pro?branch=main) |
| 5 | + |
| 6 | +A Laravel-based flash card application built with Livewire and Laravel Sail. |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +- User authentication and registration |
| 11 | +- Create and manage flash card decks |
| 12 | +- Interactive flash card system |
| 13 | +- Modern UI with Livewire Flux components |
| 14 | +- Docker development environment with Laravel Sail |
| 15 | + |
| 16 | +## Requirements |
| 17 | + |
| 18 | +- Docker |
| 19 | +- Docker Compose |
| 20 | + |
| 21 | +## Installation |
| 22 | + |
| 23 | +1. Clone the repository |
| 24 | +2. Copy environment file: |
| 25 | + ```bash |
| 26 | + cp .env.example .env |
| 27 | + ``` |
| 28 | +3. Start Laravel Sail: |
| 29 | + ```bash |
| 30 | + ./vendor/bin/sail up -d |
| 31 | + ``` |
| 32 | +4. Install PHP dependencies: |
| 33 | + ```bash |
| 34 | + ./vendor/bin/sail composer install |
| 35 | + ``` |
| 36 | +5. Install Node dependencies: |
| 37 | + ```bash |
| 38 | + ./vendor/bin/sail npm install |
| 39 | + ``` |
| 40 | +6. Generate application key: |
| 41 | + ```bash |
| 42 | + ./vendor/bin/sail artisan key:generate |
| 43 | + ``` |
| 44 | +7. Run migrations: |
| 45 | + ```bash |
| 46 | + ./vendor/bin/sail artisan migrate |
| 47 | + ``` |
| 48 | +8. Build assets: |
| 49 | + ```bash |
| 50 | + ./vendor/bin/sail npm run build |
| 51 | + ``` |
| 52 | + |
| 53 | +## Development |
| 54 | + |
| 55 | +Start the development environment: |
| 56 | +```bash |
| 57 | +./vendor/bin/sail up |
| 58 | +``` |
| 59 | + |
| 60 | +For development with hot reloading: |
| 61 | +```bash |
| 62 | +./vendor/bin/sail npm run dev |
| 63 | +``` |
| 64 | + |
| 65 | +### Sail Alias |
| 66 | + |
| 67 | +You can create a shell alias for easier usage: |
| 68 | +```bash |
| 69 | +alias sail='./vendor/bin/sail' |
| 70 | +``` |
| 71 | + |
| 72 | +Then use commands like: |
| 73 | +```bash |
| 74 | +sail up |
| 75 | +sail artisan migrate |
| 76 | +sail composer install |
| 77 | +``` |
| 78 | + |
| 79 | +## Testing |
| 80 | + |
| 81 | +Run the test suite: |
| 82 | +```bash |
| 83 | +./vendor/bin/sail test |
| 84 | +``` |
| 85 | + |
| 86 | +Or using PHPUnit directly: |
| 87 | +```bash |
| 88 | +./vendor/bin/sail artisan test |
| 89 | +``` |
| 90 | + |
| 91 | +## Code Style |
| 92 | + |
| 93 | +This project uses Laravel Pint for code formatting: |
| 94 | +```bash |
| 95 | +./vendor/bin/sail composer pint |
| 96 | +``` |
| 97 | + |
| 98 | +Or run Pint directly: |
| 99 | +```bash |
| 100 | +./vendor/bin/sail vendor/bin/pint |
| 101 | +``` |
| 102 | + |
| 103 | +## Services |
| 104 | + |
| 105 | +The application includes the following services via Docker: |
| 106 | +- **Laravel Application** - Main PHP application |
| 107 | +- **MySQL** - Database server |
| 108 | +- **Redis** - Cache and session store |
| 109 | +- **Mailpit** - Local mail testing |
| 110 | +- **Selenium** - Browser testing (when needed) |
0 commit comments