Skip to content
This repository has been archived by the owner on Jun 10, 2023. It is now read-only.

sakydev/briskLimbs

Repository files navigation

Demo BriskLimbs

The fastest video sharing software created with both webmasters and developers in mind.

Table of contents

Why BriskLimbs

There aren't many open source video solutions out there. The ones that exist are mostly painful to deal with. The frustration of having to go back and forth with customer support, lack of documentation and having to figure things out yourself, claiming features that aren't even half built and lots of similiar issues is the reason why we created BriskLimbs.

We are focused on building this project in pursest sense of open source. We have the detremination to always put the community first and build things people actually want.

Getting Started

It is easy to get started with BriskLimbs no matter if you are a developer or a webmaster with no technical knowledge.

Requirments

briskLimbs requires several tools to run smoothly. You are recomended to have them all ready before installation.

Recomendations

  • OS: Ubuntu or Centos
  • Server: VPS or Dedicated
  • Memory: 8GB or higher
  • Space: Completely depends on your usage
  • PHP max_execution_time: 5400 or higher
  • PHP upload_max_filesize: 10 - 20% higher than your largest uploads

Installation

Once you have installed and configured all required tools you can begin installing briskLimbs.

Latest Stable Version
wget https://github.com/briskLimbs/briskLimbs/archive/v2.0.1-stable.zip
unzip briskLimbs-2.0.1-stable.zip
cd briskLimbs-2.0.1-stable
composer install
Latest Development Version
git clone https://github.com/briskLimbs/briskLimbs.git
cd briskLimbs
composer install

That's it. Now visit "http://{yourhost}/briskLimbs" in your browser and follow configuration instructions.

Are you having problems installing? Shoot an email at brisklimbs@gmail.com and we'll be happy to do it for you. FREE :)

Official Addons

Addons allow you to extend basic functionality of BriskLimbs by adding new features, enhancing existing ones or simply making something easier.

FAQ

  • Is briskLimbs free?

Yes, briskLimbs is one hundered percent free to use for any of your personal or commercial projects. We may introduce premium addons in future but this software will always be free.

  • How do I request custom features?

You can send an email at brisklimbs@gmail.com and our team will be in touch within 24 hours.

  • How do I install a new skin?

Extract contents of downloaded zip and then login to your server via Filezilla or similar FTP program and upload extracted contents under /skins directory. Once finish simply refresh your skins manager and now you should see your addon.

  • How do I install a new addon?

Extract contents of downloaded zip and then login to your server via Filezilla or similar FTP program and upload extracted contents under /addonsdirectory. Once finish simply refresh your addons manager and now you should see your addon.

  • What are supported video formats?

BriskLimbs uses mp4 as standard format and can convert several other formats to it. The supported formats are follow:

- 3GP
- AVI
- FLV
- M4V
- MKV
- MOV
- MP4
- MPG
- MPEG
- MTS
- WEBM
- WMV
- VOB

Contribute

First of all, we are honoured that you consisdered us worthy of your time, your grace :)

We'll be super excited to have you on board and you can get started in few simple steps.

  1. Please make sure to read Coding Conventions and Addon Development if you are planning to build addons
  2. Fork this project, make any changes as you see fit and send us a pull request

And that's it. :)

Directory structure

├── addons                          # all addons are placed here
│   ├── developerTools              # addon for making developer tools available for admins
│   │   ├── developerTools.php      # main file for addon
│   │   ├── install.php             
│   │   ├── pages                   
│   │   │   ├── configs.php
│   │   │   ├── info.php
│   │   │   └── requirements.php
│   │   └── plugin.json             # file responsible for defining an addon
│   └── geoLocation                 # addon for tracking user location
│       ├── functions.php
│       ├── install.php             
│       ├── location.php            # main file addon
│       └── plugin.json             # file responsible for defining an addon
├── admin                           # admin dashboard files
│   └── skins                       # admin skins are placed here
│       └── default                 # holds backend and frontend files for skin
│           ├── addons.php          # admin addons manager
│           ├── blank.php           
│           ├── index.php           # admin dashboard
│           ├── page.php            # blank page used for embeding pages requested by addons
│           ├── settings.php        # admin settings
│           ├── skeleton            # holds frontend files for admin skin
│           │   ├── addons.html
│           │   ├── blank.html
│           │   ├── dashboard.html
│           │   ├── layout.html
│           │   ├── settings.html
│           │   ├── signin.html
│           │   ├── users.html
│           │   └── videos.html
│           ├── users.php           # admin users manager             
│           └── videos.php          # admin videos manager
├── config.php                      # initializes core of briskLimbs
├── configs                         # holds configuration files
│   ├── configs.php                 # holds static overall configurations 
│   ├── constants.php               # defines base constants  
│   ├── db.php                      # holds database credentials, created on installation
│   └── db.sample.php               
├── daemons                         # these are files used for running background processes
│   └── conversion.php              # handles entire conversion process of a video
├── helpers                         # helper functions that speed things up
│   ├── devFunctions.php            # functions purely for easing up development process
│   ├── functions.php               # general functions
│   └── videoFunctions.php          # video related functions
├── index.php                       # all requests land on this page and get routed
├── installer                       # handles installation of briskLimbs
│   ├── assets                      # files used for styling UI
│   │   ├── bootstrap.min.css   
│   │   └── signin.css
│   ├── functions.php               # main functionality of installer 
│   ├── imports                     # sql files to be imported at start
│   │   ├── addons.sql
│   │   ├── settings.sql
│   │   ├── users.sql
│   │   └── videos.sql
│   ├── install.php                 # main file for handling installation
│   ├── pages                       # sub pages for handling installation sections
│   │   ├── checks.php              # runs requirement checks 
│   │   ├── finish.php              # runs final updates
│   │   ├── footer.php
│   │   ├── header.php
│   │   ├── import.php              # imports sql files
│   │   └── installation_exists.php # already installed message
│   │   └── release.php             # displays release information
│   ├── release.json                # holds release information
│   └── requirments.json            # holds requirements
├── media                           # directory where all media is stored
│   ├── avatars                     # stores user avatars
│   │   ├── admin.jpg
│   │   └── default.svg
│   ├── logs                        # stores video logs
│   ├── temporary                   # stores video while it is being processed
│   ├── thumbnails                  # stores video thumbnails
│   └── videos                      # stores videos after they have been processed
├── model                           # holds core classes
│   ├── Actions.php                 # handles tracking actions
│   ├── Addons.php                  # all addon related actions
│   ├── Conversion.php              # video conversion and thumbnails generation
│   ├── Database.php                # mysql wrapper in PHP
│   ├── Errors.php                  # handles errors globally
│   ├── Files.php                   # handles scanning, moving and deletion of files
│   ├── Limbs.php                   # handles Twig and performs as bridge between model and view
│   ├── Settings.php                # handles fetching and updating of website settings
│   ├── Thumbnails.php              # handles scanning, moving and deletion of thumbnails
│   ├── User.php                    # wrapper functions for a single user
│   ├── Users.php                   # users related actions
│   ├── Video.php                   # wrapper functions for a single video
│   └── Videos.php                  # videos related actions
├── README.md
├── skins                           # holds frontend skins
│   └── ivar                        # default skin 
│       ├── 404.php
│       ├── assets
│       │   ├── css
│       │   │   ├── custom.css
│       │   │   ├── iconfonts
│       │   ├── fonts
│       │   │   └── Ubuntu
│       │   ├── images
│       │   └── js
│       │       ├── plupload.full.min.js
│       │       ├── upload.js       # handles main video uploader
│       │       ├── video-js        # handles main video player
│       │       └── watch.js        # handles actions on watch page
│       ├── index.php
│       ├── search.php
│       ├── signin.php
│       ├── signout.php
│       ├── signup.php
│       ├── skeleton                # frontend files for default skin
│       │   ├── blank.html
│       │   ├── bricks              # reusable blocks of code
│       │   │   ├── player.html
│       │   │   ├── trending.html
│       │   │   └── video.html
│       │   ├── home.html
│       │   ├── layout.html
│       │   ├── search.html
│       │   ├── signin.html
│       │   ├── signup.html
│       │   ├── upload.html
│       │   └── watch.html
│       ├── upload.php
│       ├── videos.php
│       └── watch.php
└── utils                           # holds additional utility files

License

BriskLimbs is available under MIT License. You can read more here

Credits