Giter Site home page Giter Site logo

iqltechnologies / brighty Goto Github PK

View Code? Open in Web Editor NEW
52.0 26.0 6.0 219 KB

[UNRELEASED] Brighty is web hosting automation, billing and provisioning platform. Developed for the sane web hosts who want reliability, security and peace of mind

License: Other

PHP 100.00%
vue vuejs whmcs codeigniter4

brighty's Introduction

Brighty - Web Hosting Automation, Billing and Provisioning Platform for the Sane Hosts

๐Ÿ‘‹ Hi There! We are creating a production-level "WHMCS Alternative" with integrated billing, automation and provisioning Platform for web hosters. This project aims to give you a usable and extendable platform with minimal but all required features to run a web design agency or a hosting company.

PULL REQUEST status PULL REQUEST PHP Version Require Laravel BoxBilling Size Scrutinizer Code Quality

Every one is fed up of paid web hosting automation software!

So What do we do? The answer is to create something together. In our experience, current alternatives are not only outdated (and in code debt) but also needs to be built keeping in view the current needs of the industry. We want to create something which we will use ourselves in production.

Not Limited to Hosting, it can be used for any kind of automated billing and provisioning business.

Architecture: Keeping it simple with WordPress and WooCommerce

This app is made up of four different and independent parts. These parts are envisioned to be built independednt of each other and each should work on a separate hosting accounts/server or on same hosting account. To achieve this, all necessary integrations are built-in.

  • Website : This is where users will be able to purchase your products such as domain name, website, packages, hosting etc; (WordPress Theme and Static HTML Site integration Code)
  • Client Area: This is where your customers will be able to login and manage their accounts, view invoices, domain names, hosting and login to control panels etc.; (Woocommerce My Account Area)
  • Backend / API: This is the API used by Website, Admin Area, and Client Area to fetch and store data; (WordPress REST API)
  • Admin Area : used to manage and control your products, orders, users, servers, domains etc.; (WordPress Dashboard)

๐Ÿ“… Release Date for V1.0 (Tentative)

We are targeting to release it by 1 Nov 2023.

Status: Not Usable. Just Started. We are in early development/ideation stage.

Looking for Core group.

Notes & Decisions

It was initially planned to be developed using laravel or codeigniter however upon realizing the fact that wordpress & woocommerce have quicker development time, more flexibility and a vast amount of available plugins, I decided that it is a wiser decision to go with using wordpress as a backend.

The only issue here seems to be scalability issues howver that is accounted for because our frontend is basically plain & simple old html & css. The user dashboard and admin dashboards are also accounted for in other ways.

๐Ÿค Join Our Community

๐Ÿšด Current Goals

  • Integrate a login script - allows you to create a login popup and logged-in user bar on any site by interting a few lines of js code
  • User Registration | Supported: Social Media, Mobile, Email, Email Verification, SMS Verification etc.
  • User Dashboard / Client Panel
Domain Name ๐ŸŒ :Hosting ๐Ÿ–ฅ๏ธInvoice ๐Ÿ“ƒ
Automated Registration | Supported : LogicboxesCWP automated ProvisioningCreate Invoice
Name Server UpdateHosting Package PurchaseInvoice Payment
Domain Contact UpdateOne Click Hosting Control Panel LoginAutomated Invoice Generation
Domain Contact UpdateHosting Renwal ReminderInvoice Payment Reminder

Payment Gateways ๐Ÿ’ณ

  • Paypal - RazorPay - Skrill - Stripe

๐Ÿ”Œ Pluggable Architecture

Using WordPress-Like Plugin Architecture allows you to develop plugins, search and activate them from the marketplace

๐Ÿ† Developing

Fork and Use docker compose in this repo. Database and Code is included together. Pull Request are welcome

Development Stacks:

  • WordPress
  • MySQL
  • Bootstrap

Requirements

Client Area and Admin Area

Client Area and Admin Area have no special requirement as they are static HTML 

Backend (API)

It is built on WordPress; PHP version 7.3 or newer with following extensions intalled: *intl*, *mbstring* php-json, php-mysqlnd, php-xml. A database is also required.

Installation Instruction

You can install Client Area, Admin Area, Website and API separately as well as together(easy). Follow these steps carefully

Option 1 : One Click Installer

  • Download Brighty.zip and Upload one level above public directory (generally public_html on cpanel and /var/www/html elsewhere; do not upload zip to public_html or html instead one level up eg. www).
  • In your browser open your-url.tld/install and follow on-screen instruction

Option 2 : Manual Install

  • For latest development version download project as zip or download a stable release(Recommended)
  • Go to public directory of your hosting (generally public_html on cpanel and /var/www/html elsewhere) and upload the contents of public folder there.
  • edit brighty-config.json and place your brighty backend url there (with protocol and trailing slash) Frontend installation is complete.
  • to install backend upload everything including public directory one level above public. make sure contents of public directory are public and nothing else otherwise your system will be open to everyone for playing aka hacking and expliting.
  • if you want to keep your backend on the same domain/directory, move to next step otherwise if your backend is separated then remove everything other than index.php and .htaccess files from project public folder.
  • IMPORTANT : remove .htaccess and index.php from project root (/brighty folder) regardless of your previous step as it is there for helping us during development only
  • Login to your frontend with

Installation Note:

  • there is no specific admin url. To access admin area you need to login as a normal urser with admin credentials

๐Ÿ“— License

Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)

Documentation

  • This plugin registers a page template and uses it. The template is located in /templates
  • The user dashboard page is located on /templates/user-dashboard.php
  • most functions code is located on /functions/do.php

Registration Page: Create a page named register or anything. When creating the page select template - "Brighty Full Width if you want to use full width". @/templates/full-width.php Insert a shortcode on that page [brighty_register_form] @function/do.php : @/template/woocommerce/register.php the code for registration form is located on

TODO

  • kirki plugin
  • send email on account details update
  • highlight field in registration form on error
  • Use endpoint url function instead of hardcoding it for woocommerce
  • Use endpoint urls in ajax requests on list notifications page
  • combile js functions in same file for manageability

brighty's People

Contributors

tariq-abdullah avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

brighty's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.