mirror of
https://github.com/pacnpal/thrillwiki_laravel.git
synced 2025-12-20 09:31:11 -05:00
feat: create designers table and update Park model to use Operator for ownership
This commit is contained in:
128
README.md
128
README.md
@@ -1,66 +1,106 @@
|
||||
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
|
||||
</p>
|
||||
# ThrillWiki - Laravel/Livewire Implementation
|
||||
|
||||
## About Laravel
|
||||
This is the Laravel/Livewire implementation of ThrillWiki, maintaining feature parity with the original Django project.
|
||||
|
||||
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
|
||||
## Prerequisites
|
||||
|
||||
- [Simple, fast routing engine](https://laravel.com/docs/routing).
|
||||
- [Powerful dependency injection container](https://laravel.com/docs/container).
|
||||
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
|
||||
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
|
||||
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
|
||||
- [Robust background job processing](https://laravel.com/docs/queues).
|
||||
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
|
||||
- PHP 8.1 or higher
|
||||
- PostgreSQL
|
||||
- Node.js and npm
|
||||
- Composer
|
||||
|
||||
Laravel is accessible, powerful, and provides tools required for large, robust applications.
|
||||
## Setup Instructions
|
||||
|
||||
## Learning Laravel
|
||||
### 1. Environment Configuration
|
||||
|
||||
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
|
||||
```bash
|
||||
# Copy the example environment file
|
||||
cp .env.example .env
|
||||
|
||||
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
|
||||
# Generate application key
|
||||
php artisan key:generate
|
||||
```
|
||||
|
||||
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
|
||||
Configure your `.env` file with the following essential settings:
|
||||
|
||||
## Laravel Sponsors
|
||||
```env
|
||||
DB_CONNECTION=pgsql
|
||||
DB_HOST=127.0.0.1
|
||||
DB_PORT=5432
|
||||
DB_DATABASE=thrillwiki
|
||||
DB_USERNAME=your_username
|
||||
DB_PASSWORD=your_password
|
||||
```
|
||||
|
||||
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
|
||||
### 2. Database Setup
|
||||
|
||||
### Premium Partners
|
||||
1. Create PostgreSQL database:
|
||||
```sql
|
||||
CREATE DATABASE thrillwiki;
|
||||
```
|
||||
|
||||
- **[Vehikl](https://vehikl.com/)**
|
||||
- **[Tighten Co.](https://tighten.co)**
|
||||
- **[WebReinvent](https://webreinvent.com/)**
|
||||
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
|
||||
- **[64 Robots](https://64robots.com)**
|
||||
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
|
||||
- **[Cyber-Duck](https://cyber-duck.co.uk)**
|
||||
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
|
||||
- **[Jump24](https://jump24.co.uk)**
|
||||
- **[Redberry](https://redberry.international/laravel/)**
|
||||
- **[Active Logic](https://activelogic.com)**
|
||||
- **[byte5](https://byte5.de)**
|
||||
- **[OP.GG](https://op.gg)**
|
||||
2. Run migrations and seed the database:
|
||||
```bash
|
||||
php artisan migrate:fresh --seed
|
||||
```
|
||||
|
||||
## Contributing
|
||||
### 3. Install Dependencies
|
||||
|
||||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
||||
```bash
|
||||
# Install PHP dependencies
|
||||
composer install
|
||||
|
||||
## Code of Conduct
|
||||
# Install Node.js dependencies
|
||||
npm install
|
||||
```
|
||||
|
||||
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
|
||||
### 4. Start Development Servers
|
||||
|
||||
## Security Vulnerabilities
|
||||
Run these commands in separate terminal windows:
|
||||
|
||||
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
|
||||
```bash
|
||||
# Start Laravel development server
|
||||
php artisan serve
|
||||
|
||||
## License
|
||||
# Start Vite development server for asset compilation
|
||||
npm run dev
|
||||
```
|
||||
|
||||
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
For production:
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
### 5. Clear Cache (If Needed)
|
||||
|
||||
```bash
|
||||
php artisan cache:clear && php artisan config:clear && php artisan route:clear && php artisan view:clear
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
1. **Assets Not Loading**
|
||||
- Ensure Vite is running (`npm run dev`)
|
||||
- For production, make sure assets are built (`npm run build`)
|
||||
|
||||
2. **Database Connection Issues**
|
||||
- Verify PostgreSQL is running
|
||||
- Check credentials in `.env` file
|
||||
- Ensure database exists and is accessible
|
||||
|
||||
3. **Migration Errors**
|
||||
- Check migration order in `database/migrations`
|
||||
- Ensure database is empty when running `migrate:fresh`
|
||||
|
||||
## Development Guidelines
|
||||
|
||||
This implementation maintains strict feature parity with the original Django project. Key requirements:
|
||||
|
||||
- Feature-to-Feature matching with Django implementation
|
||||
- Identical API responses and data structures
|
||||
- Consistent UI/UX with original
|
||||
- Test coverage matching Django functionality
|
||||
|
||||
For detailed development guidelines, refer to the project documentation.
|
||||
|
||||
Reference in New Issue
Block a user