mirror of
https://github.com/m1ngsama/php.git
synced 2025-12-24 16:01:19 +00:00
Add comprehensive documentation
Created detailed README with feature list, installation guide, and architecture overview.
This commit is contained in:
parent
7a9fd58601
commit
8a17eb65c0
1 changed files with 49 additions and 0 deletions
49
README_FORUM.md
Normal file
49
README_FORUM.md
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
# Reddit-Like Community Forum
|
||||||
|
|
||||||
|
A full-featured community forum built with Laravel, inspired by Reddit.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- User authentication (registration, login, logout)
|
||||||
|
- Community creation and management
|
||||||
|
- Post creation with multiple types (text, link, image)
|
||||||
|
- Nested comment threading
|
||||||
|
- Upvote/downvote system for posts and comments
|
||||||
|
- User karma tracking
|
||||||
|
- Community subscriptions
|
||||||
|
- User profiles with activity history
|
||||||
|
|
||||||
|
## Database Schema
|
||||||
|
|
||||||
|
- **Users**: User accounts with karma scores
|
||||||
|
- **Communities**: Subreddit-like communities
|
||||||
|
- **Posts**: User-submitted content
|
||||||
|
- **Comments**: Nested comments on posts
|
||||||
|
- **Votes**: Upvotes and downvotes
|
||||||
|
- **Community_User**: User subscriptions to communities
|
||||||
|
|
||||||
|
## Routes
|
||||||
|
|
||||||
|
- `/` - Home page with popular posts
|
||||||
|
- `/register` - User registration
|
||||||
|
- `/login` - User login
|
||||||
|
- `/communities` - Browse all communities
|
||||||
|
- `/r/{community}` - View community posts
|
||||||
|
- `/posts/{post}` - View post details and comments
|
||||||
|
- `/u/{user}` - View user profile
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
- Laravel 12
|
||||||
|
- Tailwind CSS
|
||||||
|
- Blade Templates
|
||||||
|
- MySQL/SQLite
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Clone the repository
|
||||||
|
2. Run `composer install`
|
||||||
|
3. Copy `.env.example` to `.env`
|
||||||
|
4. Generate application key: `php artisan key:generate`
|
||||||
|
5. Run migrations: `php artisan migrate`
|
||||||
|
6. Start the server: `php artisan serve`
|
||||||
Loading…
Reference in a new issue