https://github.com/franeklubi/clubi

A group-oriented social media platform written in Laravel and Vue
https://github.com/franeklubi/clubi

api clubi group groups laravel laravel-application laravel-framework open-api openapi3 sanctum social-media social-network social-networks swagger swagger-api

Last synced: 7 days ago
JSON representation

A group-oriented social media platform written in Laravel and Vue

• Host: GitHub
• URL: https://github.com/franeklubi/clubi
• Owner: franeklubi
• License: mit
• Created: 2020-07-16T20:52:54.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-01T21:04:12.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T07:51:32.513Z (14 days ago)
• Topics: api, clubi, group, groups, laravel, laravel-application, laravel-framework, open-api, openapi3, sanctum, social-media, social-network, social-networks, swagger, swagger-api
• Language: PHP
• Homepage:
• Size: 3.49 MB
• Stars: 31
• Watchers: 5
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Clubi

![logo.png](./assets/logo.png)

### Clubi is a group-oriented social media platform written in Laravel.

Visit us at: https://clubi.franeklubi.com/

---

* [Features](#features)

* [Documentation](#documentation)

* [Contributing](#contributing)

---

![responsive.png](./assets/responsive.png)

*Showcase of the responsive design*

# Features

* open api with token auth that's prepared for potential app development (go to [documentation](#documentation) to learn more)

* allows for easy (public or private) group creation and management

* displays notifications, such as:

    - new post in Your group

    - someone has liked Your post/comment

    - someone has joined Your group

    - someone has left a comment on Your post

* distinguishes between users, group admins, and site admins

* implements user-specific feed containing latest posts from all groups the user has joined

* implements invitation system with specified controls such as: necessary admin approval for invitations to private groups

* ranks 10 most popular groups on site

* allows for searching groups by name or their id string

* users are able to attach pictures to posts/comments and also like them

* contains badges next to username indicating user's relevance:

    - post author

    - group admin

    - site admin

* implements 'Load more' functionality for posts and comments

* uses responsive design

# Documentation

For API documentation, visit this link: [generated swagger doc](https://generator.swagger.io/?url=https://raw.githubusercontent.com/franeklubi/clubi/master/docs/openapi.yaml)

# Contributing

Clubi welcomes contributions of any kind :)

To start contributing clone the repository and run `./dev_setup.sh` to help get You started. This script will:

* install composer and npm packages

* compile js assets

* copy the .env.example to .env

* generate secure key with artisan

* open .env in vim for You to modify it