Orange-box

A modern content, documentation, and project management system built with Laravel. Organize knowledge, manage projects, collaborate with teams, and streamline your workflow from a single platform.

🌐 Live URL: https://box.oranbyte.com

Key Feature

Core Features

• Daily Digestions
• Think Pad
• Syntax Store
• Folder Factory (File Manager)
• Password Locker
• Personal Portfolio
• Authentication (Login, Register, Lock Screen, Password Reset)
• Admin Dashboard / User login

Project Management

• Projects
• Modules
• Tasks
• Team Collaboration
• Progress Tracking
• File Sharing

Documentation Engine

• GitHub Repository Integration
• Automatic Documentation Sync
• Markdown Editor
• Live Preview
• Version Management
• Releases
• Documentation Analytics
• Teams & Permissions
• Privacy & Terms Pages
• Social Links
• Sponsor Support
• Custom Branding
• Custom pages support
• Template Selection

Notifications

• Task Updates
• Module Updates
• Project Invitations
• Comments & Replies
• Mentions
• Documentation Updates
• Unlisted Content Visits
• Security Alerts

Settings

• Notification Preferences
• Security (2FA, Master Key, Lock Screen)
• Theme & Appearance
• Account Settings

Productivity

• Global Search
• Favorites
• Recent Activity
• Tags

Screenshots

Core

Project Management

Documentation Engine

Settings And Productivity

Shoutout Libraries And Framework

Tech Stack

• Backend: Laravel 11 (PHP)
• Database: MySQL
• Frontend: Bootstrap 5
• Icon Libraries: Boxicons, Bootstrap Icons, Iconify Icons, Feather Icons
• Rich Text Editors: Summernote, Editor.js, CKEditor

Integrated Libraries

• Media Viewer (Custom) – https://github.com/suraj-repositories/media-viewer
• JS Toastify (Custom Toast Notifications) – https://github.com/suraj-repositories/JS-Toastify
• SweetAlert2 (Beautiful Alerts) – https://sweetalert2.github.io/
• Select2 (Advanced Select Boxes) – https://select2.org/
• ApexCharts (Interactive Charts) – https://apexcharts.com/
• jQuery (JavaScript Library) – https://jquery.com/

Steps to use

1. Clone the repository.

   git clone https://github.com/suraj-repositories/Orange-box.git

2. Navigate to the project directory.

   cd Orange-box

3. Install PHP dependencies.

   composer install

4. Install JavaScript dependencies.

   npm install

5. Create the environment file.

   cp .env.example .env

   Windows

   copy .env.example .env

6. Generate the application key.

   php artisan key:generate

7. Configure your database credentials in the .env file.

8. Run the database migrations.

   php artisan migrate

   (Optional) Seed the database:

   php artisan db:seed

9. Create the storage symlink.

   php artisan storage:link

10. Build the frontend assets.

    Development

    npm run dev

    Production

    npm run build

11. Start the development server.

    php artisan serve

12. Open your browser and visit:

    http://127.0.0.1:8000
    

Optional Commands

Clear application cache:

php artisan optimize:clear

Run the queue worker: (keep it running to perform queue related tasks - like documentation udpate)

php artisan queue:work

Run the scheduler: (Run this based on routes/console.php file to update analytics dashboard)

php artisan schedule:work

🧡 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.